freeCodeCamp / freeCodeCamp/devdocs
Documentation sorting
- Lenguaje dominante
- Ruby
- Estrellas
- 39.5k
- Forks
- 2.6k
- Merge medio
- 4 d 32 min
- PR fusionados (30 d)
- 13
Descripción
# 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

N/B: This is my opinion
Guía de contribución
Línea de trabajo
Start by reviewing the documentation-navigation implementation and the README vision linked in the issue. Compare the current alphabetical ordering with the original documentation order, then clarify whether the intended result is preserved source order, a user-controlled switch, or another design; done should include an agreed behavior and supporting tests.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- css, html, javascript, react, sass, typescript
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100