freeCodeCamp / freeCodeCamp/devdocs

Documentation sorting

Open
#1,753 2 comments 3 reactions 0 assignees View on GitHub
feature
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.