docs: umbrella accuracy pass (self-updating versions + @rudderjs framing)#54
Merged
Conversation
…ing) - Root README: replace the hardcoded version column with npm version badges so it stops drifting on every release (was showing 0.3.0/0.1.0 while published is 0.5.0/0.2.1/0.1.2/0.1.2/0.2.1). - Correct the '@rudderjs/* are thin deprecated re-exports' framing in the root README, ai-sdk README, and the Architecture.md graduation playbook. Per the epic #1 decision, @rudderjs/ai is the living Rudder binding (re-export + AiProvider + ORM stores + CLI), not a dying shim. Resolves a self-contradiction in ai-sdk/README (line 5 said deprecated shim, line 48 said the ORM stores live there). Closes #53
suleimansh
added
documentation
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
1 participant
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.
Closes #53. Docs only, no code/API change.
1. Version table no longer drifts
The root README's Packages table hardcoded versions (
ai-sdk 0.3.0, the rest0.1.0/0.2.0) while npm is at0.5.0 / 0.2.1 / 0.1.2 / 0.1.2 / 0.2.1. Replaced the Version column with shields.io npm badges (linked to each npm page) so it self-updates and never goes stale again.2. Corrected the "deprecated re-export" framing
Per the epic #1 decision (2026-06-27),
@rudderjs/aiis not a dying shim — it re-exports the agnostic engine and owns the Rudder-coupled bindings (AiProvider, ORM-backed stores, doctor,make:agent/ai:evalCLI) that cannot graduate. It is the living Rudder binding.packages/ai-sdk/README.mdwas self-contradictory: line 5 called@rudderjs/ai"a thin deprecated re-export" while line 48 said the ORM stores live there. Fixed line 5 to match reality.Architecture.mdgraduation playbook now notes the old-name package can be either a deprecated shim or a living framework binding (re-export + framework-coupled pieces), with@rudderjs/aias the example.Not touched
Sibling cross-linking is already good (every package README links
ai-sdk; the two MCP packages cross-reference). No changeset: the root README + Architecture.md aren't published, and theai-sdkREADME line rides the next release.