Skip to content

Workflows

Resume The Repo

  1. Read README.md.
  2. Read docs/index.md and the relevant model or architecture entrypoint.
  3. Read docs/context/contracts.md before making structural documentation changes.
  4. Check git status --short --branch so active edits are not mistaken for clean baseline.

Update Model Or Integration Docs

  1. Edit the canonical markdown page under docs/models/, docs/architecture/, or docs/development/.
  2. Update the corresponding PlantUML source in docs/diagrams/ or docs/models/**/interactions/ when terminology or flow behavior changes.
  3. If the change affects cross-repo ownership, update docs/reference/repo-boundaries.md and the relevant repo-context page.
  4. Rebuild the docs site from the repo root with python -m mkdocs build -f D:\github\dirac-abs\mkdocs.yml.

Refresh Repo MCP Docs

  1. Run python D:\github\workspace-mcp\scripts\mcp_provision.py dirac-abs.
  2. Keep existing repo-authored MCP docs unless explicit overwrite is intended.
  3. Refine docs/agent/ and docs/context/ so they describe the real repo instead of generated defaults.

Wrap The Repo

  1. Remove transient logs or local scratch artifacts created during the session.
  2. Append session context to .session.md.
  3. Stage intended repo changes, commit them, and push to the tracked remote.