Skip to content

Editing

Source is markdown in github.com/agentic-learning-ai-lab/agentic-learning-ai-lab-wiki (private). Two ways to edit.

Quick edit (browser)

Click the pencil icon at the top-right of any page. That opens the file in GitHub's web editor. Save your changes as a PR against dev.

Good for: typos, small additions, dead links.

Local edit

Clone, edit, push a PR.

git clone git@github.com:agentic-learning-ai-lab/agentic-learning-ai-lab-wiki.git
cd agentic-learning-ai-lab-wiki
pip install -r requirements.txt
mkdocs serve   # preview at http://127.0.0.1:8000

Edit files under docs/, branch off dev, push, open a PR.

Good for: bigger changes, multiple files, anything you want to preview before sending.

PR flow

  • All PRs target dev. Don't push directly to main.
  • Always request the PI as reviewer (CODEOWNERS does this automatically). Wait for their approval before merging.
  • Merging to dev updates the preview at dev.agentic-learning-ai-lab-wiki.pages.dev.
  • CF Pages also posts a per-commit preview URL on each PR.
  • Merging dev → main deploys production at wiki.agenticlearning.ai.
  • CI runs mkdocs build --strict on every PR; broken links or missing nav entries fail the check.