freeCodeCamp / freeCodeCamp/devdocs

Documentation sorting

Ouverte
#1,753 2 commentaires 3 réactions 0 personnes assignées Voir sur GitHub
feature
Langage dominant
Ruby
Étoiles
39.5k
Forks
2.6k
Merge moyen
4 j 32 min
PR mergées (30 j)
13

Description

# Feature request

## Summary

The docs navigation has been arranged in alphabetical order.
Pro: skimming for the topic is easier.
Con: Doesn't provide the flow of the original documentation; some documentations are best read in order since some topic(s) link to another. An example is React documentation (if I am not wrong).

Solution 1:
In the docs navigation, I think the docs should be sorted alphabetically while their headings/topics/links should be sorted as-is in the original documentation for continuous flow.

Solution 2:
Please provide a sorting mechanism (switch) either as-is from the source doc for those who prefer continuous flow or alphabetically to those who prefer alphabetical order.

## Examples

I prefer

▷ ...

▷ ...
▷ CSS
▷ HTML
▷ JavaScript
▽ React
▷ Installation
▷ Main Concepts
▷ Advanced Guide
▷ API Reference
▷ Hooks
▷ Testing
▷ ...
▷ ...
▷ Sass
▷ SVG
▷ Typescript
▷ ...
▷ ...

to

![image](https://user-images.githubusercontent.com/66219869/168924996-55b3038e-2748-47e2-aaf4-cf87cee85fe6.png)

N/B: This is my opinion

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.