docs(readme,cli): document /new & zero upgrade, add Discord link, and sync help text#489
docs(readme,cli): document /new & zero upgrade, add Discord link, and sync help text#489PierrunoYT wants to merge 7 commits into
Conversation
Add the /new slash command and zero upgrade command to the README's command references, expand docs/UPDATE.md to cover the --apply install flow, and link the project Discord server.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
WalkthroughDocs and CLI help now surface ChangesDocumentation and help surface updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/UPDATE.md`:
- Around line 46-49: The Markdown table entry for the `--endpoint` option is
being split into extra columns because the placeholder contains an unescaped
pipe. Update the `docs/UPDATE.md` options table entry for `--endpoint` so the
placeholder no longer uses a raw pipe character, or escape it consistently with
the other table content; keep the change localized to the `--endpoint` row so
the table renders correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 32621c51-ed9f-4af9-a670-98d9e442accf
📒 Files selected for processing (3)
README.mdREADME_ZH.mddocs/UPDATE.md
CodeRabbit flagged the unescaped | in the --endpoint placeholder breaking the Markdown table layout.
Vasanthdev2004
left a comment
Vasanthdev2004
left a comment
There was a problem hiding this comment.
Docs check out — /new and zero upgrade/--apply all match what the code actually does, and UPDATE.md finally covering the apply flow is a real gap filled.
Two things before it goes in:
- The Discord invite (
N9CrWCH7b) expires 2026-08-02, about a month out — its metadata showsexpires_atset. It does resolve to the "Gitlawb Community" guild so it's the right server, but a headline-README link that stops working in 30 days isn't great. Regenerate it as a never-expire invite and swap that in. - README_ZH only picked up the Discord link — it's still missing the /new and
zero upgradeadditions the English README got. Worth bringing it in line so the Chinese readme doesn't drift behind.
Rest is good.
README_ZH.md had picked up the Discord link but was still missing the /new slash command and zero upgrade entries added to README.md, letting the translation drift out of sync.
jatmn
left a comment
jatmn
left a comment
There was a problem hiding this comment.
I found a couple of issues that need to be addressed before this is ready.
Findings
-
[P2] Replace the expiring Discord invite before publishing it in the READMEs
README.md:11
The new README and README_ZH links usehttps://discord.com/invite/N9CrWCH7b, but the current invite metadata reportsexpires_at: 2026-08-02T15:11:41+00:00. That means the headline badge/community link will stop working about a month after this lands. Please replace both README links with a never-expiring invite before merging the docs update. -
[P2] Keep the root help in sync with the newly documented upgrade command
internal/cli/app.go:1040
The README now documentszero upgradeas a common command, and the CLI dispatch does handleupgrade, butzero --helpstill lists onlyupdatein the Commands section. That leaves the built-in command discovery out of sync with the README/docs update this PR is making. Please addupgradeto the root help output, and cover it in the existing root-help test so the documented command does not drift again.
There was a problem hiding this comment.
Pull request overview
This PR updates Zero’s user-facing documentation to reflect recently added session/upgrade capabilities and adds a Discord community link, plus a small CLI help text update to surface the upgrade command.
Changes:
- Document
/newandzero upgradein both READMEs, and add a Discord badge + Community section. - Expand
docs/UPDATE.mdto cover the--apply/zero upgradeflow (including npm vs standalone behavior and Windows handling). - Add
upgradeto the top-level CLI help command list and adjust the help-output test expectations.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Discord link, documents /new and zero upgrade, and adds a Community section. |
| README_ZH.md | Mirrors README updates in Chinese (Discord link, /new, zero upgrade, Community section). |
| docs/UPDATE.md | Expands update documentation to include --apply / zero upgrade behavior and constraints. |
| internal/cli/app.go | Adds upgrade to the top-level zero help command list. |
| internal/cli/app_test.go | Updates help-output assertions to include upgrade. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| zero update check for newer releases | ||
| zero upgrade download, verify, and install the latest release |
| zero update 检查更新版本 | ||
| zero upgrade 下载、验证并安装最新版本 |
| auth Log in to model providers via OAuth | ||
| sandbox Inspect sandbox policy and persistent grants | ||
| update Check for Zero CLI updates | ||
| upgrade Apply available Zero CLI updates |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
PierrunoYT
changed the title
jatmn
left a comment
jatmn
left a comment
There was a problem hiding this comment.
Thanks for the updates. I rechecked the changed paths and found issues that still need to be addressed.
Findings
-
[P1] Get the linked issue approved before continuing this community PR
CONTRIBUTING.md:19
This PR is from aCONTRIBUTORaccount and links#488, but the linked issue currently has no labels, so it does not have theissue-approvedlabel required by the contribution policy. CONTRIBUTING says community PRs opened before the related issue has that label may be closed without review. Please get#488reviewed and markedissue-approved(or have a maintainer explicitly record an exception) before continuing the implementation fixes below. -
[P2] Replace or remove the expiring Discord invite before publishing it
README.md:11
The README and README_ZH links still usehttps://discord.com/invite/N9CrWCH7b, and the current invite metadata still reportsexpires_at: 2026-08-02T15:11:41+00:00. That means the headline badge and community links will stop working shortly after this lands. Please replace both README links with a never-expiring invite, or leave the community link out until a permanent invite is available. -
[P2] Complete Copilot's request to make the README update command match the CLI
README.md:285
Copilot flagged this after the help-text update, and the current README tables still list barezero updateas "check for newer releases" / "检查更新版本". The actual command still errors unless the user passes--checkor--apply, whilezero upgradeis the apply shorthand. Please update both README.md and README_ZH.md so the common-commands examples usezero update --checkor otherwise make the required flag explicit.
zero update errors without --check or --apply, so the bare form in the common-commands examples was misleading. Addresses the Copilot finding from the PR Gitlawb#489 review.
Vasanthdev2004
left a comment
Vasanthdev2004
left a comment
There was a problem hiding this comment.
Approving. Everything jatmn and I flagged is handled.
The Discord invite was the only real blocker — the old N9CrWCH7b expired 2026-08-02, so the headline README link and badge would have died in about four weeks. I swapped it for a permanent one (CaQDS6wdFn) in both READMEs and pushed it here; I checked it against the Discord API first — expires_at is null and it still resolves to the Gitlawb Community guild.
The docs themselves were already accurate: /new in the slash table, zero upgrade in Common Commands, the --apply/upgrade install flow in UPDATE.md, and the help-text sync in app.go (update now reads "check for or apply," plus the new upgrade line) all match what the code does. UPDATE.md finally covering the apply flow filled a genuine gap.
Marked #488 issue-approved. Thanks @PierrunoYT — solid docs work, and the community link is durable now.
Summary
/newslash command to the README's slash-command table (added in polish: cut per-turn overhead, stabilize cache, add /new #478, not previously documented).zero upgradeto the README's Common Commands list (added in feat(update): add zero upgrade command to apply self-updates #461).--apply/zero upgradeinstall flow (npm delegation, standalone binary replace, Windows rename-aside,--targetrestriction) — it previously only covered--check.upgradeto rootzero --helpoutput and update the corresponding root-help test expectation.Closes #488
Test plan
internal/cli/update.go,internal/tui/commands.go).upgradeand kept help expectations in sync (internal/cli/app.go,internal/cli/app_test.go).Summary by CodeRabbit
New Features
zero upgradecommand to download/verify/install available CLI updates./newcommand in the interactive TUI to start a fresh session while keeping prior sessions saved.Documentation
zero update --checkvszero update --apply, document exit-code behavior and JSON output, and recommendzero upgradefor existing installs.