Website for documentation
CaBRNet will need a proper documentation website. What should be on it?
- brief description of the library
- examples
- installation guide
- contribution guidelines
- list of contributors
We have several possibilities as a tools
- sphinx, the venerable one, able to generate API docs from string
- docusaurus, the new fancy boi with Typescript built-in integration
Do we need autogenerated API docs (as in, will the API change a lot)? How easy would it be to contribute for other people?