Skip to content

Add docs snippet validation gate#47

Open
bfernando wants to merge 1 commit into
wraith-protocol:developfrom
bfernando:bfernando/snippet-ci-gate-27
Open

Add docs snippet validation gate#47
bfernando wants to merge 1 commit into
wraith-protocol:developfrom
bfernando:bfernando/snippet-ci-gate-27

Conversation

@bfernando

@bfernando bfernando commented Jun 24, 2026

Copy link
Copy Markdown

Summary

  • add a Node/TypeScript snippet checker that extracts TS/JS MDX fences and compiles them with tsc --noEmit
  • add a GitHub Actions workflow for snippet checks on PRs and pushes to develop/main
  • add a non-blocking Stellar testnet validation job that verifies five Horizon response shapes
  • document the snippet workflow and no-check opt-out in docs/CONTRIBUTING.md
  • mark existing illustrative schema/service fragments as no-check

Notes

The first CI gate is intentionally syntax-focused because the current docs contain many illustrative fragments and API-shape examples that are not standalone programs. The Stellar job is non-blocking because it depends on live testnet/network availability.

Validation

  • npm test
  • npm run check:stellar-testnet
  • npx tsc --noEmit

Fixes #27

@drips-wave

drips-wave Bot commented Jun 24, 2026

Copy link
Copy Markdown

@bfernando 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! 🚀

Learn more about application limits

@bfernando bfernando marked this pull request as ready for review June 24, 2026 10:38
@truthixify

Copy link
Copy Markdown
Contributor

Merge is clean. The snippet validator + testnet variant + CI workflow + CONTRIBUTING update all look good.

One blocker: drop package-lock.json (2184 lines, npm). This repo uses pnpm.

rm package-lock.json
git add -u
git commit --amend
git push --force-with-lease

After that I will merge.

@truthixify

Copy link
Copy Markdown
Contributor

Test-merges cleanly otherwise. The 2184-line package-lock.json is still in the PR. This repo uses pnpm.

rm package-lock.json
git add -u
git commit --amend --no-edit
git push --force-with-lease

Snippet validators + CI wiring + CONTRIBUTING update all look good once the lockfile is gone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants