Repository navigation
docs(design): grade every design rule as MUST, SHOULD or MAY - #452
Merged
Merged
Conversation
- Rewrite DESIGN, INTERACTION, ACCEPTANCE, WORKFLOW_PATTERNS and the ranui adapter as ID-tagged rule bullets (183 MUST, 271 SHOULD, 11 MAY). A MUST names its proof: browser, recording, unit, review, a verify:design check or a test path. - Add bin/design-rules.ts: it rejects normative wording outside a graded rule, malformed tags, duplicate IDs, missing or unknown proofs, and renders design/RULES.md plus the ranui adapter index. - Run it from sync:design and verify:docs, ship docs/RULES.md in the ranui package and the agent plugin, and add node tests. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Deploying ran with
|
| Latest commit: |
439dc08
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3f4a062b.ran-4ty.pages.dev |
| Branch Preview URL: | https://docs-design-rule-grading.ran-4ty.pages.dev |
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
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
This is P1 of the design-guidance improvement plan: every design rule now has a stable ID and a BCP-14 level.
Graded rules.
design/DESIGN.md,INTERACTION.md,ACCEPTANCE.md,WORKFLOW_PATTERNS.mdand the ranui adapter are rewritten as ID-tagged bullets, for example- **X-INPUT-6 · MUST** … _Proof: browser_. Totals: 183 MUST, 271 SHOULD, 11 MAY.Proofs. Every MUST names its proof:
browser,recording,unit,review,check:<verify:design rule>ortest:<path>. All nineverify:designchecks now back a rule. Where a test covers only part of a rule,reviewis added.bin/design-rules.tsrejects:It also renders the rule indexes
design/RULES.mdandpackages/ranui/docs/adapters/RULES.md. Adapter anchors are resolved against the combined generated page.--lint <file>checks a single file.Wiring.
sync:designandverify:docsrun the new script.docs/RULES.mdships in the ranui package and the agent plugin.Review
Two independent review passes compared every file against its previous text, for lost meaning, mis-grading, inconsistent levels across files and proof fit. All 43 findings were applied. Highlights:
remvsem) to SHOULD;Known limits
Verification
pnpm verify:docs(includes the rule index check, the design and plugin sync checks, andcheck:langs)pnpm verify:linksnode --test bin/test/*.test.ts: 59/59, of which 11 are new rule testspnpm typecheck:toolingand oxlint onbinpnpm -F ranui exec vitest run test/unit/docs.interface-guidance.test.ts test/unit/docs.references.test.ts: 131/131pnpm -F ranui verify:design: no new violations (294 known)🤖 Generated with Claude Code