Skip to main content

Weekly Docs Automation

Use this runbook to configure a weekly Codex automation for DialNexa docs updates. The automation prepares a source delta report, updates the affected docs, asks for screenshots when needed, updates the changelog, validates the site, and opens a draft PR.

What The Helper Scripts Do

  • scripts/prepare_weekly_docs_update.py reads DOCS_SOURCE_SNAPSHOT.md, refreshes master refs for dashboard-fe, dashboard-be, and speech-ai, and writes a report under .docs-update-reports/.
  • When dashboard-be has new commits, the prepare script also writes .docs-update-reports/<run>/dashboard-be-v1-api-docs-audit.md. This audit compares added /v1 Nest routes against api-reference/openapi.json and flags removed /v1 routes that are still present in OpenAPI or docs prose, so API changes cannot be missed silently.
  • If the reported dashboard-be diff touches src/modules/mcp/**, run the export pipeline directly (see “MCP tool changes” below), then run python3 scripts/validate_mcp_tool_docs.py.
  • scripts/add_changelog_entry.py inserts a dated entry into the matching monthly changelog page from a JSON file. It blocks em dash and en dash punctuation in visible changelog text.
The prepare script uses the correct local source repo names: It also accepts the older misspelled dashbaord-fe and dashbaord-be paths as fallback aliases.

Manual Test Command

Run this from the docs repo root:
Then open:

Codex Automation Setup

Create a new Codex automation with these settings:
  • Workspace: /Users/kamat/Documents/projects/api-docs
  • Schedule: weekly, at the day and time you want the docs review to start
  • Model: use the strongest coding model available in your Codex automation settings
  • Prompt: paste the prompt below

Changelog Entry Helper

Create a JSON file like this when the weekly docs update is ready for changelog entry:
Insert it with:
The helper creates changelog/<month-year>.mdx when the month page does not exist. Add any new monthly page under the Changelog > Platform group in docs.json.

Weekly Review Rules

  • Do not update DOCS_SOURCE_SNAPSHOT.md until the docs have been edited and validated.
  • Do not open a PR while waiting for screenshots.
  • Keep changelog pages month-specific, with the same structure as changelog/may-2026.mdx: short intro, Documentation Index callout, sidebarTitle, mode: "center", monthly H2, dated H2 sections, and concise H3 update titles. Set tag: "LATEST" only on the newest month page.
  • In each monthly update summary, use one table row per H3 update. Link each Update cell and each dated H3 update title to the exact destination section for that change, not just the page top.
  • If a source repo has local changes, the prepare script fetches origin/master but does not pull into that worktree. Use the reported origin/master commit for review.
  • Treat dashboard-be-v1-api-docs-audit.md as a required checklist, not as a final decision. It flags route/OpenAPI gaps, stale documented removed routes, and stale removed-route prose references; Codex must still inspect the controller and DTO source before documenting, deleting, or excluding a route.
  • Treat stale documentation as part of the weekly review. A removed or unsupported source feature should remove or revise docs even when no replacement feature was added.
  • Keep .docs-update-reports/ untracked. It is ignored by git.