Contributing

Contents:

• Clone, Install
• Build the Docs
• Opening a Pull Request

Contributions to this documentation are welcome.

Technical Info:

• The documentation is written in Markdown.
• The documentation site is generated using MkDocs- configured via a single YAML configuration file
• The Documentation theme applied is Material for MkDocs. Here is a reference to get started

Clone, Install

Clone the Repo

$ gh repo clone Steel-Ridge-Partners/dev-docs

And install the requirements

$ pip install -r requirements.txt

Build the Docs

$ mkdocs serve

Point your browser to http://localhost:8000 to see your docs.

Opening a Pull Request

Create a branch (don't forget to pull in main!) and when your changes are ready, open a Pull Request.

Note

Please reference our Commit Guidelines and Pull Request Workflow pages for more detail.