Skip to content

Contributing to these docs

These docs live in the docs.innerloop.community repo and are built with MkDocs Material.

Edit in the browser

Each page has an edit icon in the top right that opens the source Markdown on GitHub. Make your change, open a pull request, done.

Edit locally

```bash git clone git@github.com:innerloopcommunity/docs.innerloop.community.git cd docs.innerloop.community

python -m venv .venv source .venv/bin/activate pip install -r requirements.txt

mkdocs serve ```

Then open http://127.0.0.1:8000. The site reloads when you save a file.

Adding a page

  1. Drop a new .md file under docs/.
  2. Wire it into the nav: block of mkdocs.yml.
  3. Cross-link it from a relevant section.

Style notes

  • Sentence-case headings.
  • Short paragraphs; bullet lists over walls of text.
  • Code samples are runnable where possible.
  • Prefer linking to existing pages over restating their content.