-
Notifications
You must be signed in to change notification settings - Fork 4
Snippet runtime correctness audit #7
Copy link
Copy link
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programauditProduces a written report as primary deliverableProduces a written report as primary deliverabledocsDocumentationDocumentationdripsFunded via Drips NetworkFunded via Drips Networkhelp wantedExtra attention is neededExtra attention is neededtestTest coverage / harnessTest coverage / harness
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programauditProduces a written report as primary deliverableProduces a written report as primary deliverabledocsDocumentationDocumentationdripsFunded via Drips NetworkFunded via Drips Networkhelp wantedExtra attention is neededExtra attention is neededtestTest coverage / harnessTest coverage / harness
Type
Fields
Give feedbackNo fields configured for issues without a type.
Labels:
Stellar Wave,audit,test,docs,drips,help-wantedTier: M (2–4 days)
Type: audit + test
Context
Every MDX file in the docs has TypeScript snippets. We claim they're "copy-paste runnable." We have not verified that. Some snippets reference function signatures that have changed; some import paths are wrong; some never compiled in the first place.
We want a snippet-correctness CI gate.
Scope
scripts/check-snippets.tsthat:.mdxfile underdocs/.ts,tsx,typescript, orjavascript.tsc --noEmitagainst it with a tsconfig that has@wraith-protocol/sdk+ chain deps installed.```ts no-checkfor snippets that are intentionally illustrative pseudo-code.Bonus
Acceptance criteria
check-snippets.tsruns locally and in CI.docs/CONTRIBUTING.md.Why this matters
The docs are our most public artifact. A broken snippet in introduction.mdx affects every reader equally. Static type-checking is the cheapest, fastest way to catch this.