docs(0.50.1): top-tier SDK presentation — README, examples, guides#121
Merged
Conversation
Docs-only patch — zero code changes, zero API surface changes vs 0.50.0. - Rewritten root README.md as a top-tier OSS landing page: - Table of contents - "What you get back" with annotated InsightReport JSON - Three quickstart paths (selfImprove / analyzeRuns / intake adapters) - Comparison matrix vs LangSmith / Braintrust / Phoenix - Three customer journey cards linking to examples/ - Subpath entry points table - Stability + versioning section - Three runnable examples in examples/: - selfimprove-quickstart/ — closed-loop journey, offline (synthetic driver) - customer-feedback-loop/ — multi-rater corpus → fromFeedbackTable → analyzeRuns - customer-otel-traces/ — production OTel spans → fromOtelSpans → analyzeRuns Each example: README + index.ts runnable via `pnpm tsx`. Prints the decision packet to stdout. - docs/insight-report.md — annotated walkthrough of every section of the decision packet with real JSON samples + how to read each section. - docs/customer-journeys.md — three end-to-end journeys mapped to customer maturity stages (logs only → ratings → closed loop). - docs/concepts.md — added "three top-level functions" mental model + repo layering rule at the top. - CHANGELOG.md — Keep-a-Changelog format back to 0.42. Future releases follow this shape. Version: 0.50.0 → 0.50.1 (npm + PyPI locked).
drewstone
approved these changes
May 27, 2026
Contributor
drewstone
left a comment
drewstone
left a comment
There was a problem hiding this comment.
✅ Auto-approved tangletools PR — af1cf937
This PR was opened by the trusted tangletools automation account.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.
tangletools · auto-approval · reason: tangletools_author · 2026-05-27T19:30:36Z
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.
Summary
Docs-only patch to bring the repo presentation to a top-tier OSS standard. Zero code changes, zero API surface changes vs 0.50.0.
What's in
README.mdrewritten as a landing page: TOC, "show me the money" InsightReport JSON sample, three quickstart paths, comparison matrix vs LangSmith / Braintrust / Phoenix, customer journey cards.examples/:selfimprove-quickstart/— closed-loop journey, offline via a synthetic driver.customer-feedback-loop/— multi-rater corpus journey end-to-end.customer-otel-traces/— production OTel-spans journey end-to-end.Each has its own README +
index.tsrunnable viapnpm tsx.docs/insight-report.md— annotated walkthrough of every section of the decision packet with real JSON samples + how to act on each section.docs/customer-journeys.md— three end-to-end journeys with code + expected output.docs/concepts.md— added "three top-level functions" mental model + repo layering rule at the top.CHANGELOG.md— Keep-a-Changelog format back to 0.42.Verification
pnpm typecheckcleanpnpm test— 1427 / 1427 passingpnpm tsx examples/customer-feedback-loop/index.tsprints the expected reportpnpm tsx examples/customer-otel-traces/index.tsprints the expected reportpnpm tsx examples/selfimprove-quickstart/index.tsprints the expected report (offline, no LLM credits needed)