Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Sort sidebar menus by alphabetical order #137

Open
vasco3 opened this issue Feb 28, 2020 · 5 comments
Open

Sort sidebar menus by alphabetical order #137

vasco3 opened this issue Feb 28, 2020 · 5 comments

Comments

@vasco3
Copy link
Contributor

vasco3 commented Feb 28, 2020

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

@ryyppy
Copy link
Member

ryyppy commented Feb 28, 2020

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
Copy link
Contributor Author

vasco3 commented Feb 28, 2020

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
Copy link
Member

ryyppy commented Mar 2, 2020

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
Copy link
Member

ryyppy commented May 2, 2020

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
Copy link
Contributor Author

vasco3 commented May 3, 2020

awesome!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants