docs(ts): revamp TypeScript READMEs for install-first clarity - #541
Draft
aimable100 wants to merge 1 commit into
Draft
docs(ts): revamp TypeScript READMEs for install-first clarity#541aimable100 wants to merge 1 commit into
aimable100 wants to merge 1 commit into
Conversation
Retitle the workspace README around both packages, lead with npm install, make the five-minute path note NODE_ENV for devRoot, defer PoP/nonce into MCP, and split consumer vs develop sections. Shorten the package READMEs to match.
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
tenuo-ts/README.mdas the TypeScript SDK workspace (core + mcp), with install first and a runnable five-minute path that calls outNODE_ENV/devRootrequirements.sessionFromWire/narrow.@tenuo/coreand@tenuo/mcppackage READMEs so npm landings stay short and point at the workspace README for depth.Test plan
tenuo-ts/README.mdas a first-time installer: install → five minutes → production → MCPexamples/mcp/host.tsand workspace README relatives