test(cli): lint assets/docs for our-process words shipped to callers - #5370
Open
HelloOjasMutreja wants to merge 1 commit into
Open
test(cli): lint assets/docs for our-process words shipped to callers#5370HelloOjasMutreja wants to merge 1 commit into
HelloOjasMutreja wants to merge 1 commit into
Conversation
packages/cli/assets/docs ships to people building WITH Astryx; material about building Astryx itself (grading rubrics, promotion gates, review evidence) keeps landing there instead of the wiki, and it was only ever caught by a human reading the diff. facebook#5368 added the README with the audience rule and routing table; this is the automated half. Checks for rubric/readiness/promotion/sign-off/evidence, a narrower list than the README's own "tells" section: audit/checklist/gate were the obvious additions, but all their current hits are innocent prose ("Verification Checklist", "Audit every reset stylesheet"), and a noisy check gets suppressed. Measured against main (0 hits) and the draft that prompted this, facebook#5351 (56 hits).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
github-actions
Bot
added
community
HelloOjasMutreja
marked this pull request as ready for review
August 23, 2026 22:14
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR No new or modified components detected. Bundle Size SummaryNo component packages changed. Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
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.
Fixes #5369.
Problem
packages/cli/assets/docs/ships to people building with Astryx. Material about building Astryx itself (grading rubrics, promotion gates, review evidence) keeps landing there instead of the wiki, and it was only ever caught if a human happened to read the diff. #5368 added a README to that directory with the audience rule and a routing table; this is the automated half the issue asked for.What it checks
Added a case to
packages/cli/foundation/discovery/docs-discovery.test.mjs, which already walksassets/docs, per the issue's suggestion. Fails onrubric,readiness,promotion,sign-off,evidence(case-insensitive, word-boundary) appearing in any.mjsfile there.Deliberately narrower than the README's own longer "tells" list.
audit,checklist, andgatewere the obvious additions, but checked first: all their current hits in the directory are innocent prose ("Verification Checklist", "Audit every reset stylesheet"), andlabcollides withlabel/available148 times. A noisy check gets suppressed rather than acted on, so I left those out.Verified the five-word list is clean today (0 hits) and matches what the issue measured against the draft that prompted it (#5351, 56 hits) — didn't re-run that PR's diff since it's someone else's draft, took the issue's numbers as the baseline signal instead.
.mjs-only is deliberate too: it naturally excludesREADME.md, which legitimately contains all five words since it's the document describing the rule — filtering by extension is simpler than an explicit exclude-list and won't need updating if another non-.mjsfile shows up in the directory later.The failure message points at the README's routing table so the author knows which wiki page the material actually wants, per the issue's ask.
Verification
Confirmed the test fails against a real violation: temporarily appended a comment with
rubric,readiness,evidencetogetting-started.doc.mjs, ran the suite, watched it fail with the expected message naming the word and file, then reverted. Fulldocs-discovery.test.mjssuite: 23/23 passing. Typecheck and lint clean.Not a visual change (a test file, no rendered output), so no screenshot.