Skip to content

Workflows

Update Reader-Facing Hardware Docs

  1. Edit the relevant page under docs/.
  2. Keep terminology consistent with docs/reference/terminology.md.
  3. If the change introduces a durable repo decision, record it under docs/adr/.
  4. Rebuild the site and verify the rendered output.

Normalize The Repo To Template Standard

  1. Align mkdocs.yml with the current OVES MkDocs template baseline.
  2. Keep .docs-template-info.json, hooks/, and overrides/partials/ in sync with the template contract.
  3. Ensure docs/agent/, docs/context/, docs/adr/, and docs/reference/ exist.
  4. Rebuild the site and check the git diff before commit.

Refresh MCP Contract Files

  1. Run python D:\github\workspace-mcp\scripts\mcp_provision.py oves-hard-tech.
  2. Review generated or refreshed files under docs/agent/ and docs/context/.
  3. Replace generic wording with repo-specific descriptions when needed.
  4. Re-run the workspace inventory if registry output needs to be refreshed.