devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Retain original order of the content in the documentation

Open ghost opened this issue 6 years ago • 6 comments

The content in the documentation is ordered alphabetically which is good but it can very helpful for beginners if it's ordered in the official documentation order. It will make it super easy for beginners to get started with a language or framework using devdocs. Here is an example from laravel 5.6 documentation:

If I open the official laravel 5.6 documentation it shows up in this order:


1. Prologue
2. Getting Started
3. Architecture Concepts
4. The Basics
5. Frontend
6. Security
7. Digging Deeper
8. Database
9. Eloquent ORM
10. Testing
11. Official Packages

This order makes it super easy to get started with laravel 5.6 and understand the documentation.

If I open the laravel 5.6 devdocs documentation, it shows up in this order:


1. Architecture Concepts
2. Database
3. Digging Deeper
4. Eloquent ORM
5. Frontend
6. Getting Started
7. Official Packages
8. Prologue
9. Security
10. Testing
11. The Basics

This order makes it harder to understand and get started with laravel 5.6.

It will be great to have something that could be added in the preference section to enable/disable the default documentation order to make it easier for understanding new concepts and this would also attract more developers to devdocs.

ghost avatar Dec 14 '18 18:12 ghost

I would be glad to take up this and work on it over the holidays. I might reach out to ask a couple of questions though @tauseefsshah. Hope that is fine by you?

ascii-dev avatar Dec 20 '18 22:12 ascii-dev

Nice! If you need any help, feel free to have a chat with other contributors on Gitter :)

jmerle avatar Dec 20 '18 22:12 jmerle

Sure I will. Thanks much @jmerle

ascii-dev avatar Dec 20 '18 22:12 ascii-dev

Thanks @ascii-dev This sounds great, feel free to reach me for questions and contributions, would love to help :)

ghost avatar Dec 21 '18 17:12 ghost

@Thibaut What do you think about this feature?!

ghost avatar Feb 10 '19 15:02 ghost

Wow! I was just about to suggest this feature, the guidelines directed me here. I'm thinking if there could be a separate page that arranges the links in the original order. Users could just follow from there. It's a very great user experience.

the-real-i9 avatar Nov 11 '21 04:11 the-real-i9