Skip to content

docs: refresh published SDK examples - #47

Merged
snchimata merged 2 commits into
mainfrom
docs/readme-examples-refresh
Nov 12, 2026
Merged

snchimata merged 2 commits into
mainfrom
docs/readme-examples-refresh

Conversation

@snchimata

Copy link
Copy Markdown
Owner

Summary

  • Align README quickstarts and the tracked notebook with the published Python/npm 0.6.0 SDKs.
  • Clarify in-process Node fitting and keep legacy compression under the low-level/CLI APIs.
  • Refresh the README demo, add its evidence-backed renderer, and publish linked development-only benchmark evidence with regression tests.

Validation

  • Python: 29 focused docs/notebook/README/evidence/renderer tests passed (83 subtests).
  • Python examples: examples/sdk_fit.py and examples/quickstart.py ran with published tokenfold==0.6.0.
  • Node: npm test passed (48 tests, zero skips) after the documented native build and test environment setup.
  • README GIF regenerated and verified against the 0.6.0 wheel and release CLI.

snchimata and others added 2 commits November 11, 2026 21:25
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@snchimata
snchimata merged commit a5aafaf into main Nov 12, 2026
34 checks passed
@snchimata
snchimata deleted the docs/readme-examples-refresh branch November 12, 2026 04:39
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.

1 participant