Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tabbed pane: better nomenclature, more prominent documentation #154

Open
deining opened this issue Mar 26, 2023 · 1 comment
Open

tabbed pane: better nomenclature, more prominent documentation #154

deining opened this issue Mar 26, 2023 · 1 comment
Labels
feature New feature or request

Comments

@deining
Copy link
Contributor

deining commented Mar 26, 2023

What is missing in the project?

Shadocs theme supports tabbed panes, but this can be easily overlooked:

  • tab shortcode is not documented at all,
  • snippet shortcode acts as container for child tabs (represented by tab shortcodes) but name of the shortcode does not reflect this at all.

I think there is room for improvement here. Why don't we split up the current snippet shortcode into two separate shortcodes:

  • tab-container shortcode: to be created
  • snippet shortcode: all current snippet functionality, except for nested shortcode support.

Afterwards, the documentation should be reworked to reflect these changes

WDYT?

Solution?

No response

@jgazeau jgazeau added the feature New feature or request label Mar 26, 2023
@jgazeau
Copy link
Owner

jgazeau commented Mar 26, 2023

Hi @deining ,

Indeed seems totally relevant. I might have taken a shortcut when adding the tab feature to the snippet code 😓
Your proposal seems fine to me, I'll add it as soon as I can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants