Docs quality: make the project map true - #285
Merged
Merged
Conversation
Checked the docs against the filesystem rather than reading them, on the theory that a map is worth exactly what its worst entry is worth. AGENTS.md's Project Structure documented **12 frontend files that do not exist**: LandingPage, DocsPage, SecurityPage, LegalPage, SentinelPage, PublicLayout, LandingNav, LandingFooter, DocsDiagrams, EmptyState, and a DocsPage test. They are the public marketing site, which moved to the standalone site at sentinel-command.com and left the map behind. This is the worst place in the doc set to be wrong. The project map is the first thing a developer or an LLM reads to orient, and a third of the frontend section was fiction — so the reader's first act is to look for files that aren't there, and their conclusion is that the docs cannot be trusted. Rewritten from the real tree, which also captures two structural changes that were never recorded: the Sentinel agent's config UI now lives in McpPage.jsx (there is no SentinelPage), and AdminPage gained the motion history tab. The tests/ listing was equally stale — it named three files and there are thirteen. The backend half of the map was accurate and is untouched. Separately, docs/image-specs/ is 2.1 MB across 17 files that NOTHING in this repository references. They fed DocsDiagrams.jsx, which left with the marketing site, and several still say "SourceBox Sentry" in their titles. I did not delete them: whether the standalone site regenerates from these or holds its own copies is not knowable from here, and the safe wrong answer is cheaper than the unsafe one. Added a README stating what they are, why they are orphaned, and the question whose answer decides their fate — so the next person inherits a decision rather than a mystery. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Checked the docs against the filesystem rather than reading them — a map is worth exactly what its worst entry is worth.
AGENTS.md documented 12 frontend files that don't exist
LandingPage,DocsPage,SecurityPage,LegalPage,SentinelPage,PublicLayout,LandingNav,LandingFooter,DocsDiagrams,EmptyState, and aDocsPagetest. They're the public marketing site, which moved to the standalone site and left the map behind.This is the worst place in the doc set to be wrong. The project map is the first thing a developer or LLM reads to orient. A third of the frontend section was fiction, so the reader's first act is to look for files that aren't there — and their conclusion is that the docs can't be trusted.
Rewritten from the real tree. That also captured two structural changes never recorded anywhere:
McpPage.jsx— there is noSentinelPageAdminPagegained the motion history tabThe
tests/listing was equally stale: it named three files, there are thirteen.The backend half of the map was accurate and is untouched.
docs/image-specs/— 2.1 MB referenced by nothing17 JSON diagram specs that fed
DocsDiagrams.jsx, which left with the marketing site. Several still say"SourceBox Sentry"in their titles.I didn't delete them. Whether the standalone site regenerates from these or holds its own copies isn't knowable from this repo, and deleting the only copy of design source isn't recoverable. Added a README stating what they are, why they're orphaned, and the one question whose answer decides their fate — so the next person inherits a decision rather than a mystery.
79 links and anchors verified.
🤖 Generated with Claude Code