Skip to content

Commit 48a2e57

Browse files
committed
docs(tooling): rewrite docs-autogen README for Docusaurus; misc fixes
**tooling/docs-autogen/README.md** — full rewrite: - Remove all Mintlify-specific content (docs.json, SidebarFix, apidocs-orphans, Mintlify dev server, api-reference.mdx, Known Issues section) - Update pipeline overview: api/index.md landing page, normalize_rst_backticks pass in step 2, step 3 (nav rebuild) noted as auto-skipped in Docusaurus mode - Correct apidocs-quality description (includes methods by default, not excluded) - Add links to docs/PUBLISHING.md and docs/CONTRIBUTING_DOCS.md at the top - Update file structure and troubleshooting table **docs/PUBLISHING.md** — remove stale `uv run poe apidocs-orphans` reference (task was deleted when --orphans was removed from audit_coverage.py) **.github/workflows/docs-publish.yml** — add comment to release: trigger explaining it only fires for manually-created releases (automated releases use GITHUB_TOKEN which cannot trigger new workflow runs) Assisted-by: Claude Code
1 parent 0949fef commit 48a2e57

3 files changed

Lines changed: 89 additions & 156 deletions

File tree

.github/workflows/docs-publish.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ on:
1414
- "tooling/docs-autogen/**"
1515
- ".github/workflows/docs-publish.yml"
1616

17+
# Fires for manually-created GitHub Releases only. Automated releases use
18+
# GITHUB_TOKEN, which cannot trigger new workflow runs — those are handled
19+
# by an explicit workflow_dispatch from the snapshot-docs job instead.
1720
release:
1821
types: [published]
1922

docs/PUBLISHING.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,6 @@ uv run python tooling/docs-autogen/audit_coverage.py \
144144
# Audit docstring quality only (via poe alias)
145145
uv run poe apidocs-quality
146146

147-
# Find orphan MDX files not in navigation
148-
uv run poe apidocs-orphans
149-
150147
# Full Docusaurus build (catches broken links)
151148
cd docs && npm run build
152149
```

0 commit comments

Comments
 (0)