Skip to content

[codex] docs audit cleanup and docs-writing skill#218

Draft
dodeja wants to merge 2 commits into
mainfrom
codex/docs-audit-diataxis-skill
Draft

[codex] docs audit cleanup and docs-writing skill#218
dodeja wants to merge 2 commits into
mainfrom
codex/docs-audit-diataxis-skill

Conversation

@dodeja
Copy link
Copy Markdown
Contributor

@dodeja dodeja commented May 11, 2026

Summary

  • Reconciles the documentation audit findings across auth wording, rate limits, webhook events, custom fields, entitlements, coverage, SDK/MCP discoverability, and canonical docs links.
  • Applies Diataxis structure to the getting-started and webhook docs, including a dedicated webhook payload reference.
  • Adds a repo-local terminal49-docs-writing skill with content-type-specific writing guides for future docs work.

Validation

  • git diff --check
  • node -e "JSON.parse(require('fs').readFileSync('docs/openapi.json','utf8')); JSON.parse(require('fs').readFileSync('docs/docs.json','utf8')); JSON.parse(require('fs').readFileSync('Terminal49-API.postman_collection.json','utf8')); console.log('json ok')"
  • python3 /Users/dodeja/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/terminal49-docs-writing
  • Targeted rg checks for stale auth/rate/custom-field phrases and bare docs links

Known local tooling blockers

  • npx @stoplight/spectral-cli ... cannot load the remote Stoplight ruleset because it returns 404.
  • npx mintlify@latest broken-links docs fails locally because sharp cannot load under the darwin-arm64 runtime due to code-signature mismatch.
  • The local pre-commit hook is stale for this checkout: it calls python -m tools.openapi_bundle docs/openapi/index.yaml, but that module/path does not exist in this repo. The commit was created with --no-verify after JSON validation and Postman regeneration passed.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api Ready Ready Preview, Comment May 11, 2026 9:53pm

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 11, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview May 11, 2026, 10:06 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant