Notesium docs: a first complete pass #112
alonswartz
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
I've published a first complete pass of the Notesium documentation at https://www.notesium.com/docs/
This includes a new Getting started section, expanded and updated documentation across the board, more examples, and a significantly fleshed-out Web Interface section. The site also includes a built-in search, which makes navigating the docs much easier.
The documentation currently covers:
The docs largely overlap with
README.mdandAPI.mdin the repository. I'm still undecided how much documentation should live in-repo versus on the website, so for now both exist.Feedback on clarity, structure, gaps, or redundancies is very welcome.
Beta Was this translation helpful? Give feedback.
All reactions