Skip to content

Contributing to the Codex

The codex is open source and community contributions are welcome!

Quick Edits (no setup required)

  1. Click the pencil icon (✏️) at the top of any page.
  2. Make your changes in GitHub's editor.
  3. Submit — GitHub will create a pull request automatically.
  4. Once a maintainer approves, your change deploys to the live site.

Local Setup

```bash

git clone https://github.com/YOURUSERNAME/uoravenous-codex.git

cd uoravenous-codex

python -m venv venv

source venv/bin/activate # Windows: venv\Scripts\activate

pip install -r requirements.txt

mkdocs serve

```

Open http://localhost:8000 — the site live-reloads as you edit.

Style Guide

  • One page per topic; keep pages focused.
  • Use tables for stats and numbers.
  • Use !!! tip / !!! warning callouts for shard-specific gotchas.
  • Screenshots go in docs/assets/images/.