Skip to content

docs: test README snippets across packages + align with webcrypto ed25519#409

Open
NiKrause wants to merge 25 commits intostoracha:mainfrom
NiKrause:docs/readme-snippet-tests-388-392-658
Open

docs: test README snippets across packages + align with webcrypto ed25519#409
NiKrause wants to merge 25 commits intostoracha:mainfrom
NiKrause:docs/readme-snippet-tests-388-392-658

Conversation

@NiKrause
Copy link
Contributor

@NiKrause NiKrause commented Feb 11, 2026

Summary

  • Improve package documentation by validating README code snippets against the current API.
  • Add dedicated README snippet tests for client, core, principal, transport, and validator.
  • Keep server README coverage with package-scoped files:
    • server-readme-snippets.spec.js
    • server-readme-integration.spec.js
  • Update README examples to match current behavior, including WebCrypto Ed25519 key handling.

Why

README snippets were drifting from implementation details. This change turns snippets into executable tests so documentation fails fast on API drift.

Based On

This branch builds on:

This PR consolidates that work and ensures package-level README snippets are validated against the current API.


Dhruv-Varshney-developer and others added 25 commits August 19, 2025 07:57
…or object

Co-authored-by: ash <alan138@gmail.com>
- Remove mock fetch from READMEs, show real server usage
- Use DID.parse() instead of ed25519.Verifier.parse() for service DIDs
- Convert client tests to use server-as-channel pattern
- Add @ucanto/server and @ucanto/validator to client devDependencies
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.

2 participants