docs: clarify free-plan region and Index-button behavior#24
Merged
Conversation
Fixes the two open README issues. - Correct the stale/incorrect region note (#8): it claimed the only supported combination was `aws`/`us-west-2`, but `us-west-2` is actually rejected on the free plan and the `.env` example uses `us-east-1`. The backend restricts free/Starter-plan serverless index creation to `aws`/`us-east-1` (returns a BadRequest asking to upgrade otherwise). Document that this is the app's default, works on the free plan with no changes, and that other regions need a paid plan. - Explain what the green "Index" button does and tell users to watch the `npm run dev` terminal to confirm the index is created and vectors are upserted (#5). Also document that `npm run dev` is the way to start the app (the other #5 ask) and fix typos in the section. Closes #8 Closes #5 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2 tasks
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
Addresses the two remaining open README issues (#8 and #5).
#8 — region confusion
The README claimed the only supported cloud/region was
aws/us-west-2and told users to "leave them defaulted." That was wrong on two counts:us-west-2is actually rejected on the free plan..envexample directly above it usesus-east-1.I verified the real rule against the backend (
pinecone-db): free/Starter-plan serverless index creation is a hard restriction toaws/us-east-1—V4_FREE_TIER_AWS_ENV_NAMESmaps to("aws","us-east-1"), andassign_serverless_envreturns aBadRequest("upgrade your plan") for any other region. This also matches the app's own default (DEFAULT_PINECONE_CLOUD/DEFAULT_PINECONE_REGION).The section now states that both env vars are optional, default to
aws/us-east-1, work out of the box on the free plan, and that other regions require a paid plan.#5 — usability additions
The issue asked for two README notes:
npm run devis how you start the project — already documented, left intact.npm run devterminal to watch index creation / upsert progress.Also fixed several typos in that section (
aaplication,havn't,recieve,similar image).Notes
Docs-only change; no code touched.
Closes #8
Closes #5
🤖 Generated with Claude Code