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

Improve documentation #50

Open

charlesLoder opened this issue Jan 28, 2023 · 1 comment

Owner

charlesLoder commented Jan 28, 2023

The documentation is lacking.

Though the code is documented decently enough for intellisense, there should be better documentation.

Typedoc is nice to generate docs from code, but it kind of a pain for making things look nice or easily navigable.

Look into docusaurus

charlesLoder added this to the v2.5.0 milestone

charlesLoder modified the milestones: v2.5.0, v2.6.0

charlesLoder removed this from the v2.6.0 milestone

Owner Author

charlesLoder commented Jun 18, 2024

Thoughts:

Typedoc to generate some JSON
maybe custom script to convert json to markdown
use Starlight for markdown
host on GH Pages (see also here)
like havarotjs, it should be it's own branch

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