feat(docs): Soroban rule documentation generator (#483)#560
Merged
mijinummi merged 1 commit intoJun 27, 2026
Merged
Conversation
Rule documentation drifts from the rules over time. This generates Markdown docs directly from the canonical rule definitions (the knowledge-base `RULES: KBRule[]`), so the docs stay in sync by construction. src/docs/rules/stellar/: - rule-metadata-parser.ts: parse rule metadata — validate required fields and severity/category enums, slugify ids, de-dup by id, sort by category+name; invalid rules are skipped and reported as issues (never throws) - rule-doc-generator.ts: render a Markdown page per rule (id, severity/category badges, summary, rationale, fenced remediation, tags, references) plus a category-grouped index with links - types.ts: ParsedRule / GeneratedDoc / options (re-uses KBRule) - index.ts: barrel + generateStellarRuleDocs() wired to the built-in catalogue - __tests__/rule-doc-generator.spec.ts: 9 tests (parse validate/dedup/sort, page + index rendering, generateDocs paths, real-catalogue generation) Verified: jest 9/9 passing; tsc reports no errors in the new module.
|
@ThatCodeBabe Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
1 task
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
2 participants
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.
Rule documentation drifts from the rules over time. This generates Markdown docs directly from the canonical rule definitions (the knowledge-base
RULES: KBRule[]), so the docs stay in sync by construction.src/docs/rules/stellar/:
Verified: jest 9/9 passing; tsc reports no errors in the new module.
closes #483