Skip to content
New issue

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

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

Already on GitHub? # to your account

Better documentation flow for new users #17204

Open
1 of 3 tasks
jbytes1027 opened this issue Dec 10, 2024 · 5 comments
Open
1 of 3 tasks

Better documentation flow for new users #17204

jbytes1027 opened this issue Dec 10, 2024 · 5 comments

Comments

@jbytes1027
Copy link
Contributor

jbytes1027 commented Dec 10, 2024

Issue

As a new user the docs are confusing. There is not a clear starting point and progression. If I want to get started what do I do and where do I go? At the bottom of the About section there is a "Getting started" section. There is also a "Getting started" tab that jumps straight to here. I also might click "How-to guides" tab which links here. Also the "Resources" tab links to a list of tutorials.

Also many of the above sections repeat the same content or point to the same resources.

Proposal

  • Use a Read the Docs theme with a linear presentation of information like the Godot docs
  • Consolidate some of the above pages.
  • Update order of getting started pages
@jbytes1027
Copy link
Contributor Author

Duplicated content example: Getting Started > Create a CMS Web app references code generation templates article, but Getting Started > Code Generation Templates has a section that repeats the same basic steps.

@Piedone
Copy link
Member

Piedone commented Dec 10, 2024

Good points! Is this something that you'd like to venture into contributing? https://docs.orchardcore.net/en/latest/guides/contributing/contributing-documentation/

@jbytes1027
Copy link
Contributor Author

Yea I can work on this.

@Piedone
Copy link
Member

Piedone commented Dec 10, 2024

Awesome! As a newcomer, you have a very different perspective than maintainers, and thus we value such contributions highly.

@sebastienros sebastienros added this to the 2.x milestone Dec 12, 2024
Copy link
Contributor

We triaged this issue and set the milestone according to the priority we think is appropriate (see the docs on how we triage and prioritize issues).

This indicates when the core team may start working on it. However, if you'd like to contribute, we'd warmly welcome you to do that anytime. See our guide on contributions here.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants