Contributor Docs

This site keeps the public path small. The repo still contains deeper material for implementation work.

Docs authoring workflow

Install docs dependencies into a virtual environment:

python -m pip install -e .
python -m pip install -r docs/requirements.txt

Preview locally:

mkdocs serve

Build the site the same way CI does:

mkdocs build --strict

Authoring rules

• teach the Chat(...) path first
• prefer short, copyable examples over provider-shaped setup
• keep notebook-derived content as edited Markdown pages in docs/
• keep API reference focused on stable public imports
• add or improve docstrings when a public page would otherwise render thinly

Repo references

• Datafiles reference notes
• Phase 1 runtime adapter RFC
• Phase 3 Responses YAML RFC
• Hosted tools and utensils checklist

Deployment

The docs workflow in .github/workflows/docs.yml builds on pull requests and deploys to GitHub Pages on pushes to master.