docs: simplify package READMEs (lean intros, details in toggles)#7
Merged
Conversation
Restructure the sdk / ai-sdk / eve package READMEs for readability: - Each feature leads with a one-line "what it does" + a minimal-comment snippet. - Options, storage details, and security/behavior notes move into collapsible <details> toggles below the snippet, instead of heavy inline comments and stacked blockquotes. - The eve "keep each agent/ file self-contained" warning moves from the top of the README to a dedicated section at the bottom. Content is unchanged — same options, same guarantees — just reorganized.
- package.json (root + 3 packages): add repository, homepage, and bugs links; homepages point to the docs pages (ai-sdk, eve) and the GitHub repo (root, core sdk). Refresh stale descriptions (drop telemetry / model cache / sandbox from core, etc.). - Chat history (README + docs): show where userId and chatId come from — userId from the auth session, chatId from the useChat id the client posts — in a full POST handler instead of bare variables. - eve install: only the AgentKit packages (@upstash/agentkit-eve, @upstash/redis, and @upstash/box for the sandbox); don't tell users to install eve or an AI-SDK provider, which an eve project already has. - Rate limiting: split the POST-only-counting explanation into its own toggle. - Prose cleanup per the "signs of AI writing" guide: cut puffery (drop-in/ready-made/self-contained/"production"), reduce em-dash density in section leads and toggle titles.
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.
Restructure the sdk / ai-sdk / eve package READMEs for readability:
Details
toggles below the snippet, instead of heavy inline comments and stacked blockquotes.Content is unchanged — same options, same guarantees — just reorganized.