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

nuxt provides a simplified version of the documentation #27162

Closed
2 of 4 tasks
1057105012 opened this issue May 11, 2024 · 2 comments
Closed
2 of 4 tasks

nuxt provides a simplified version of the documentation #27162

1057105012 opened this issue May 11, 2024 · 2 comments

Comments

@1057105012
Copy link

Describe the feature

I think nuxt's documentation is too complicated, I think there are a lot of experimental, various ingenious ideas in it, but this also brings a problem, which is the increase in cognitive cost. I hope nuxt will propose a basic template of best practices as a common development scaffold, and split the documentation into advanced and basic versions. For example, what are the core components of nuxt, routing, server-side rendering, API writing methods, these are actually all beginners care about, as for how to make images faster, fonts more elegant, these are rarely relevant in the initial stage, what beginners do not care about, I think the nuxt official can provide their own best-looking and optimal settings, not exposed to developers, just as the default values of the basic template. If the documentation is simplified, the cognitive cost is reduced, for beginners, nuxt is also easier to accept, this is a good thing. Because many times, we do not prioritize "performance" and "clever design."

Additional information

  • Would you be willing to help implement this feature?
  • Could this feature be implemented as a module?

Final checks

@manniL
Copy link
Member

manniL commented May 11, 2024

IMO that's more or less the sidebar when using "Get started"

image

What do you think would be too complicated in these sections?

@danielroe
Copy link
Member

We would definitely value improvement to the docs, and if you have any specific actionable suggestions that would be wonderful.

I'm going to close this as it's difficult to mark it as 'done' at any point. But I think we already agree it would be great to make things simpler and clearer.

@danielroe danielroe closed this as not planned Won't fix, can't repro, duplicate, stale May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants