Contributing to the Codex¶
The codex is open source and community contributions are welcome!
Quick Edits (no setup required)¶
- Click the pencil icon (✏️) at the top of any page.
- Make your changes in GitHub's editor.
- Submit — GitHub will create a pull request automatically.
- 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/!!! warningcallouts for shard-specific gotchas. - Screenshots go in
docs/assets/images/.