Skip to content

chore: remove internal docs map + sync prompt; add docs CI - #8

Merged
gtupak merged 3 commits into
masterfrom
chore/docs-sync-setup
Aug 28, 2026
Merged

chore: remove internal docs map + sync prompt; add docs CI#8
gtupak merged 3 commits into
masterfrom
chore/docs-sync-setup

Conversation

@gtupak

@gtupak gtupak commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

This pull request restructures the documentation synchronization workflow for the Mintlify docs repository. The changes include:

  1. Removed internal documentation code map (DOCS_CODE_MAP.md): Deleted a detailed reference document that mapped documentation areas to corresponding code paths in the routemesh monorepo (atlas, sentinel, front-end).

  2. Removed documentation sync prompt (PROMPT_DOCS_SYNC.md): Deleted an AI-oriented prompt document that guided automated verification of documentation accuracy against the codebase, including checks for error codes, provider portal URLs, external links, and OpenAPI consistency.

  3. Added documentation CI workflow (.github/workflows/docs-ci.yaml): Created a new GitHub Actions workflow that:

    • Runs on pull requests and pushes to main/master branches
    • Sets up Node.js 20 with npm caching
    • Installs dependencies
    • Validates the Mintlify configuration using npx mintlify validate
    • Checks for broken links using npx mintlify broken-links
    • Includes concurrency controls to cancel in-progress runs for the same branch

The overall change moves away from manual/internal documentation sync references toward automated CI-based validation of documentation quality and link integrity.

@kodus-routemesh-hosted

This comment has been minimized.

@gtupak gtupak changed the title chore: docs-sync setup (code map cleanup + docs CI) chore: remove internal docs map + sync prompt; add docs CI Aug 28, 2026
@kodus-routemesh-hosted

kodus-routemesh-hosted Bot commented Aug 28, 2026

Copy link
Copy Markdown

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Business Logic

Access your configuration settings here.

@gtupak
gtupak merged commit d1bed45 into master Aug 28, 2026
3 checks passed
@gtupak
gtupak deleted the chore/docs-sync-setup branch August 28, 2026 17:35
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