docs(readme): make Quick Start CLI-first and highlight the web dashboard - #62
Merged
Conversation
Collapse the two Quick Start sections into a single CLI-driven one: 'a2wave setup' already installs the published image and generates the compose deployment, so the clone-based Docker walkthrough (docker pull, ADMIN_PASSWORD note, macOS bind-mount block) is redundant — the macOS caveat only applies to the repo compose file's host bind mount, which keeps its inline notes, while the CLI deployment uses a named volume. Also drop content that no longer matches reality or the CLI flow: - the v0.7.2 availability NOTE (npm latest is 0.7.3-rc.1 and ships --with-postgres) - the compose-profile PostgreSQL tutorial and compose-network IMPORTANT block, replaced by 'a2wave setup --with-postgres' / --database-url; dev-side detail stays in docs/agent/postgresql.md - the stale ADMIN_PASSWORD guidance (generated .env deliberately omits it; the first login claims the admin account) Emphasize the built-in web dashboard as the management surface: new Features bullet, intro sentence, and Quick Start now routes users to the dashboard at :3502. Source-built Docker moves to one line under Local Development. Both English and zh-CN kept in sync.
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
Restructures both READMEs (EN + zh-CN) around the CLI-first install flow and the built-in web dashboard.
Quick Start (Docker)section —a2wave setupalready installs the published image and generates the compose deployment, so the clone-based walkthrough (docker pull,ADMIN_PASSWORDnote, macOS bind-mount block) was redundant. The macOS caveat only applies to the repo compose file's host bind mount (the CLI deployment uses a named volume); source-built Docker is now one line under Local Development, pointing at the notes insidedocker-compose.yml.:3502, with the admin-claim behavior matching whata2wave setupactually generates (its.envdeliberately omitsADMIN_PASSWORD; the first login claims the account). Adds thea2wave setup --upgradepath.latestis0.7.3-rc.1and ships--with-postgres) and the compose-profile PostgreSQL tutorial + compose-network IMPORTANT block, replaced bya2wave setup --with-postgres/--database-url; the dev-side detail stays indocs/agent/postgresql.md(still linked from the WARNING).Net: −99 lines across the two files, EN and zh-CN kept in sync.
Verification
Docs-only change. Claims were checked against the code:
apps/cli/src/lib/setup-plan.ts(named workspace volume, no ADMIN_PASSWORD in generated .env, default port 3502),apps/cli/src/commands/setup.ts(--with-postgres,--database-url,--upgrade),docker-compose.yml(macOS bind-mount notes present inline), andnpm view a2wave dist-tags.🤖 Generated with Claude Code