docs(README): clarify Quick Start project selection and env writing - #60
Open
sunshinexcode wants to merge 3 commits into
Open
docs(README): clarify Quick Start project selection and env writing#60sunshinexcode wants to merge 3 commits into
sunshinexcode wants to merge 3 commits into
Conversation
… clarify project selection process
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
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
Clarify the README Quick Start around interactive
agora initproject selection,--project/--new-project,.agora/project.jsonvsproject use, and that App ID / App Certificate come from the CLI writing the template env file—not a Console env download. Also align the Python templateInstallCommand/ nextSteps with the upstream quickstart (bun run setup).Type of change
error.coderename/removal)Public-contract impact
error.code— added todocs/error-codes.md.error.code— flagged as breaking, included in CHANGELOG.docs/automation.md.Test plan
go test ./...passes locally.make lintpasses locally (gofmt,golangci-lint, error-code coverage audit).internal/cli/integration_test.go.internal/cli/app_test.go(where applicable).Manual check:
nextStepsafteragora init --template pythonshowsbun run setupthenbun run dev.Documentation
CHANGELOG.mdupdated under## Unreleased(Added / Changed / Deprecated / Removed / Fixed / Security).docs/automation.mdupdated for any user-facing JSON shape, env var, or flag change.docs/error-codes.mdupdated for any newerror.code(or N/A).README.mdupdated if the command tree, install path, or quickstart changed.AGENTS.mdupdated if engineering or release process changed.Security checklist
$HOMEwithout0o600perms when it can contain credentials (e.g. session, config).unsafeimport.Additional notes
Compare: https://github.com/AgoraIO/cli/compare/docs/readme-quickstart?expand=1