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.

Sign up for GitHub

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

Jump to bottom

API reference documentation recommendations #79

Open

madjin opened this issue Apr 15, 2023 · 0 comments

madjin commented Apr 15, 2023

Since the docs are sorta generated programmatically I suggest:

sort by the headers alphabetically
do not have #### sub headers underneath each one, just use bold

this keeps the table of contents clean / easier to search

Edit this page to see the github markdown for what it should look like: https://github.com/gm3/boom-tools/wiki/API-Reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment