rescript-association / reasonml.org

Deprecated in favor of rescript-lang.org
MIT License
125 stars 33 forks source link

Sort sidebar menus by alphabetical order #137

Open vasco3 opened 4 years ago

vasco3 commented 4 years ago

The sidebar menus would be easier to read if they were ordered alphabetically. Also it would help to spot duplicates.

ryyppy commented 4 years ago

Which sidebar items are you referring to? The docs follow a certain narrative, for the API module items it follows the order of the document body

vasco3 commented 4 years ago

this one image

and this

image

for example, I wanted to know if List had a filter method. So I had to search with Cmd-F because List has many methods and they aren't sorted. If they were by alphabet then i could just skim to the methods starting with F and that way be more efficient.

ryyppy commented 4 years ago

I see, yeah that is a good idea. The index data is generated from the scripts/extract-indices.js script.. we will consider this when building the odoc json extraction tool. I'd also accept a PR that modifies the before mentioned extraction script

ryyppy commented 4 years ago

Update: we are currently in the process of generating the API docs from the actual BuckleScript modules via odoc. We will implement the sidebar ordering there.

vasco3 commented 4 years ago

awesome!