docs/README.md

Fosscord Docs

How to get started:

1. Fork this repository.

2. Clone the forked repository.

   git clone https://github.com/<YOUR_USERNAME_HERE>/fosscord-docs
   

3. Install dependencies.

   python3 -m pip install mkdocs-material mkdocs-render-swagger-plugin mkdocs-section-index
   

4. Test locally.

   • development:

     python3 -m mkdocs serve
     

   • production:

     python3 -m mkdocs build
     

5. Edit documents(s).

6. Format document(s).

   fosscord uses prettier formatter to consistently format our documents. Instructions to install and use prettier can be found here.

   If you are using vscode, install the prettier extension to automatically format documents on save.

7. Commit changes with good commit messages.

8. Create a pull request.