feat(archgate): add DOC-001 documentation consistency rule#2411
Merged
Conversation
Three automated checks: - no-phantom-source-paths: warns when README/ARCHITECTURE reference source file paths that don't exist (e.g. deleted/moved files) - no-stale-package-description: warns when a workspace package exists in packages/ but isn't mentioned in README - no-coming-soon-without-issue: warns when "coming soon" is used without a linked GitHub issue (prefer "planned" or link #issue) Motivated by 2026-03-23 audit that found 9 phantom features in docs. See PRs #2393-#2410 for the manual cleanup this rule automates.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds automated Archgate rule DOC-001 to prevent phantom features in documentation — the exact problem discovered and manually fixed in this session's audit (PRs #2393-#2410).
Three automated checks:
Motivation
2026-03-23 audit found 9 phantom features. This rule automates detection going forward.
Test plan