docs: add per-package READMEs for all symbi-* workspace packages#6
Merged
docs: add per-package READMEs for all symbi-* workspace packages#6
Conversation
npm shows a "No README found" placeholder on each of the 9 published `symbi-*` package pages because the workspace packages have no package-local README.md — only the monorepo root does. Add one focused README per package under packages/<name>/README.md: - symbi-types — types + Zod schemas; install notes; "usually re-exported from symbi-core, pull in explicitly for types-only" - symbi-core — main client; quick start; what's exported; companion packages table; links to the SDK README and runtime docs - symbi-agent — AgentClient / ScheduleClient / ChannelClient / WorkflowClient / AgentPinClient; basic example - symbi-policy — PolicyBuilder; allow/deny/audit example - symbi-secrets — SecretManager with Vault / file / env providers - symbi-mcp — McpClient; servers / tools / resources; notes tool calls flow through SchemaPin + Cedar - symbi-tool-review — ToolReviewClient; submit / track / decide - symbi-testing — MockFetch / MockAuthManager / MockSecretManager / TestEnvironment; example with mockResponse + expectCalled - symbi-cli — install via npm i -g; env config; agent/auth/dev commands; distinguishes from the Rust `symbi` runtime binary All follow the Symbiont main-repo voice: short, direct, horizontal rules between sections, no emoji-heavy headers, "official SDK for Symbiont, the policy-governed agent runtime" framing, and pointers to the main SDK README for Trust Stack integration and full examples. npm auto-includes README.md in published tarballs (verified via `npm pack --dry-run` on symbi-types — README.md appears in the tarball contents despite `files: ["dist"]`).
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.
Summary
Each of the 9 published `symbi-*` packages currently shows "No README data" on its npm page because the workspace packages have no package-local `README.md` — only the monorepo root does.
This PR adds one focused README per package under `packages//README.md`.
What each README covers
All follow the Symbiont main-repo voice: short, direct, horizontal rules between sections, no emoji-heavy headers, "Official SDK for Symbiont, the policy-governed agent runtime" framing, and links to the main SDK README for Trust Stack integration and full examples.
Publishing
npm auto-includes `README.md` in published tarballs — verified via `npm pack --dry-run` on `symbi-types`: README.md appears in the 7-file tarball despite `files: ["dist"]`. So these show up on the npm package pages the next time each `symbi-*` package is published (e.g. on a 1.10.2 release).
Test plan