Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Order of documentation entries in navigation panel #50

Open
daanboer opened this issue Mar 16, 2023 · 0 comments
Open

Order of documentation entries in navigation panel #50

daanboer opened this issue Mar 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@daanboer
Copy link
Contributor

daanboer commented Mar 16, 2023

The documentation pages are automatically generated from the markdown files in the docs folder. Additionally, the headers in these documents are automatically extracted to construct the navigation pane. The responsible function is extractMarkdownHeaders, found in the <app/src/docs/generator.ts> module. However, at the moment, the order in which the files are loaded is not controlled, and the navigation entries are scrambled. We need to think of a method to indicate the order in which the navigation links are presented. For example, the filenames could be prepended with an integer value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant