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

[Feature Request] Documentation: Remove the "show more" button in the component's code example sections #3242

Open
trival opened this issue Jun 12, 2024 · 2 comments · May be fixed by #3373
Assignees
Labels
📋 Scope : Docs Related to the documentation ✨ Type: Enhancement New enhancement on existing codebase

Comments

@trival
Copy link

trival commented Jun 12, 2024

Is your feature request related to a problem? Please describe.

As I am starting a new project and use NextUI for the first time, I use the documentation extensively and want to navigate fast to code examples. Right now, each code example is 2 clicks away, first switching tabs from "preview" to "code". Then there appears an uninformative and none interactive code excerpt with only the imports readable and the rest faded out, with a "show more" button. Only after clicking this, I can see useful examples of the component usage.

Is there a rational behind this extra two-step interaction to access the examples? Is it to prevent bots scraping the code?

Describe the solution you'd like

Could we consider removing this extra "show more" button? It would much improve the usability of the documentation in my opinion.

Describe alternatives you've considered

Documentation at mui.org sometimes shows relevant short code examples for components directly under the preview panes, with the option to open extended code listings with one click.

Documentation at tailwindui.com also shows full code examples directly after switching tabs between "preview" and "code".

Screenshots or Videos

No response

@trival
Copy link
Author

trival commented Jun 12, 2024

Just want to add that this is the ONLY little pain point so far, otherwise enjoying the experience very much, thanks!

@jrgarciadev jrgarciadev added the Improvement label Jun 29, 2024 — with Linear
@ankitts ankitts linked a pull request Jun 30, 2024 that will close this issue
@wingkwong wingkwong added ✨ Type: Enhancement New enhancement on existing codebase 📋 Scope : Docs Related to the documentation and removed Improvement labels Jun 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Scope : Docs Related to the documentation ✨ Type: Enhancement New enhancement on existing codebase
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants