Documentation
Installing and testing
Read the documentation README.md.
Structure
This documentation attempts to follow the DiƔtaxis documentation framework.
This documentation is aimed at:
- User: Using Bip
- TD: Extending Bip
- Administrator: Hosting Bip
- Developer: Developing Bip or plugins
Plugins
- Official application plugins documentation must live in
docs/user/apps. - Official handler plugins documentation must live in
docs/td/handlers.
Writing
Syntax
Use Markdown syntax. For additional formatting features, see the Material for MkDocs reference.
API
We use the MkDocs plugin MkDocstrings for generating Python API documentation from docstrings, see the reference.
Any repository that needs to be inspected must be cloned within this repository as a git submodule. Its current tag can be set up manually or via a CI job from the source repository.