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

Improve documentation #23

Open
albe opened this issue Aug 18, 2017 · 2 comments
Open

Improve documentation #23

albe opened this issue Aug 18, 2017 · 2 comments

Comments

@albe
Copy link
Owner

albe commented Aug 18, 2017

Currently the documentation is relatively unstructured and misses proper explanation/listing of all available options. Also some more practical usage examples with explanations would do good.

@albe
Copy link
Owner Author

albe commented Jan 23, 2020

Check out https://docusaurus.io/docs/en/next/tutorial-setup for documentation

@albe
Copy link
Owner Author

albe commented Mar 4, 2020

Decided for readthedocs.io now using mkdocs renderer. Docs are written as md inside the docs folder.

https://node-event-storage.readthedocs.io/en/latest/

See https://www.mkdocs.org/user-guide/writing-your-docs/ for more information, the configuration is inside the mkdocs.yml in the root.

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

No branches or pull requests

1 participant