Specification documents and API documentation for the polyproto federated messaging protocol Built with mkdocs-material and python3.12
The /docs
folder has the specification documents for the polyproto protocol. The docs/APIs
folder houses the API documentation for the polyproto-core and polyphony-chat reference implementation.
The /snippets
folder has snippets of text used in many places in the documentation. This is to ensure consistency across the documentation. Error messages appearing in many places are also stored in the /snippets/errors
folder.
The best way to contribute is to open an issue if you find any problems with the documentation. Creating an issue is generally the best way to contribute to any open source project. Issues allow for an exchange between contributors and maintainers to discuss the viability of implementing an issue, usually minimizing frustration.
You should also read our Code of Conduct and Contributing Guidelines before contributing.
You will need the following things installed on your computer:
python3.12
pip
- Any sort of python virtual environment manager - use
venv
if in doubt git
Optionally, you can install vale
for spell-/grammar checking.
Use pip install -r requirements.txt
to install the required dependencies, and mkdocs build
or
mkdocs serve
to build the project or serve it on localhost.