Skip to content

The documentation should start with a tutorial that covers most use cases #3210

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

Closed
nbro opened this issue Mar 29, 2024 · 0 comments
Closed

Comments

@nbro
Copy link

nbro commented Mar 29, 2024

Feature request

This not really a feature request for VuePress but the documentation

So, I've just started to learn Vue and VuePress.

I've been reading the official documentation: https://vuepress.vuejs.org. However, I find it unnecessarily noisy. If the most common use case for VuePress is to write documentation or portfolios with markdown files, then the documentation should start with a simple tutorial that shows how you can quickly do that.

Instead, the documentation or guides starts with a description of many details, which are or should not be necessary to get started. For example, do I need to know the purpose of all possible files that are usually under .vuepress. Clearly, not. I just want to be able to create markdown files and then turn these into web pages on my static site with just a command. That should be the first page of the documentation!

I'm at https://vuepress.vuejs.org/guide/using-vue.html#browser-api-access-restrictions and I've spent like 1-2 hours reading the docs, and I still don't know where I should put my markdown files or how to create links between the markdown files, create a navigation or menu, etc. Basically, I have lost a lot of time for something that I should have learned in the first 5 minutes while reading the official documentation

What problem does this feature solve?

Slow adoption of VuePress

How should this be implemented in your opinion?

Just change the documentation to start with what actually matters in most cases. Ideally, VuePress should be agnostic to the user's background. So, even if the user has never used Vue, he should be able to quickly create some markdown files with docs and then build the static site from them automatically. This should be clearly shown in the first page of the docs. And only after that we should have all docs about how one can customise the themes, etc.

@nbro nbro closed this as completed Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant