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

Design new documentation content structure #3942

Open
peholmst opened this issue Nov 21, 2024 · 1 comment
Open

Design new documentation content structure #3942

peholmst opened this issue Nov 21, 2024 · 1 comment
Assignees

Comments

@peholmst
Copy link
Member

peholmst commented Nov 21, 2024

We need to gradually refactor and improve our documentation. To make this easier, and to avoid SEO and redirection issues, we need to know the overall content structure up front.

Requirements:

  • The Getting Started section should contain everything you need to build a new application from scratch and deploy it to production (the "happy path"). It should be very hands-on, focusing on what you need to do rather than why.
  • The Building Apps section should contain everything you need to know to succeed with Vaadin. It should be possible to read it like a book, from start to finish.
  • Very technical articles should have their own section, so that they don't interrupt the flow of Building Apps, or confuse new users.
  • The documentation covers Vaadin as a platform, not as a set of individual products.
  • Different content is aimed at different users. Should we make personas of our audience?
@peholmst
Copy link
Member Author

Actual work on this issue happens in a Google doc.

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

2 participants