docs: trim landing + concepts, sync two-command install, link contributing to repo#69
Conversation
…uting to repo
- index.mdx: new pitch headline ("Your deploy failed. The agent already
knows why."); remove "How a stage works" and "Three pillars"; tighten
Get started to the real two-command flow; Explore 8 -> 4 cards
- quickstart.mdx, cli/install.mdx, zombies/install.mdx: drop the stale
`npx skills add` step (the npm install of zombiectl now adds the host
skill, per the live site); keep the curl one-liner as fallback
- quickstart.mdx, concepts.mdx: replace inline credit/$5 detail with the
"free until July 31, 2026" trial framing + link to usezombie.com/pricing
- concepts.mdx: de-duplicate Zombie/Tool between the four-nouns cards and
the glossary; Tool accordion becomes the tool catalog
- docs.json: add Contributing anchor -> github.com/usezombie/usezombie#contributing
- remove 4 orphaned contributing/*.mdx pages (live by URL but absent from
nav and llms.txt); contributor docs now live in the repo README
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- index.mdx: drop "signs you in" from Get started — the install skill does not handle login (`zombiectl login` is a separate step); it only registers the webhook and writes SKILL.md + TRIGGER.md - cli/install.mdx, zombies/install.mdx, quickstart.mdx: replace the unverified "symlinks"/"drops" wording with "installs" for the host-skill step, harmonized across all three pages Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The Sign in step only showed the interactive browser + 6-digit-code flow, which an agent driving the CLI (no TTY) can't complete. Add a note covering the token path: `ZOMBIE_TOKEN` env var (preferred), `--token`, or stdin, resolved in that order, plus `--no-input` to fail fast. Links to the full precedence in cli/zombiectl#zombiectl-login. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Audited every .mdx page against the zombiectl/server source and live product.
Tier 1 (confirmed factual):
- quickstart: correct login token order (--token -> ZOMBIE_TOKEN -> stdin)
- zombies/overview: drop dead /concepts#credits anchor; tenant-level billing
- zombies/troubleshooting: webhook 404 path gains /{source}; fix dead
/quickstart#wire-the-github-webhook anchor
- zombies/credentials: TRIGGER.md example uses triggers: array (singular
trigger: is rejected at install)
Tier 2 (resolved against source):
- credentials path is ~/.config/zombiectl/credentials.json (was wrong dir in
cli/zombiectl logout, missing .json in cli/configuration)
- cli/configuration: rewrite auth precedence — TTY-aware command resolution;
--token is login-only, not global
- cli/install: doctor runs 3 checks and needs no auth (was 5 + auth
short-circuit; that table had drifted from source)
- api-reference/introduction: error envelope is flat RFC 7807
application/problem+json (matches error-codes.mdx); IDs are UUIDv7
Tier 3 (free-trial framing, credit model kept):
- billing/plans, billing/budgets: add "free until July 31, 2026" banner +
pricing link; post-trial credit/wallet model retained
- workspaces/overview: webhook URL gains /{source}; soften wallet wording
Deferred: zombiectl workspace credentials body section (redirect stub; the
command table already lists it) — noted for follow-up.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…step
- Restore `${secrets.NAME.FIELD}` (was simplified to `${secrets.NAME}`; the
.FIELD component is required — a single credential can hold multiple fields,
e.g. a GitHub credential carries both a token and a webhook secret)
- Add `zombiectl login` to the Get started flow so the landing page no longer
implies the install skill signs you in (login is a separate prerequisite)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Both P1s addressed in 74a9fa6:
|
greptile flagged that the Budget accordion didn't relate the dollar ceilings to the free-trial framing above it. Source confirms computeStageCharge returns $0 while the trial is active (tenant_billing.zig FREE_TRIAL_STAGE_NANOS), so a daily/monthly ceiling won't stop a zombie for trial usage — the caps apply to the metered rate after July 31, 2026. Stated that explicitly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Fixed in e3871f2 ( Verified against source before writing:
|
What & why
Cleanup pass on the docs after reviewing them against the live usezombie.com pitch and install flow.
Changes
index.mdx— new pitch headline ("Your deploy failed. The agent already knows why.", matching the repo README H1); removed How a stage works and Three pillars (their load-bearing facts folded into prose); tightened Get started to the real two-command flow; Explore trimmed 8 → 4 cards.quickstart.mdx,cli/install.mdx,zombies/install.mdx) — dropped the stalenpx skills add usezombie/skillsstep. The live site now installs the host skill vianpm install -g @usezombie/zombiectlitself; thecurlone-liner is kept as a fallback.quickstart.mdx,concepts.mdx) — replaced inline credit/$5 metering detail with the "free until July 31, 2026" trial framing + a link to usezombie.com/pricing.concepts.mdx— de-duplicated the Zombie/Tool definitions (defined once in the four-nouns cards; the glossary's Tool entry is now a tool catalog).docs.json— added a Contributing anchor →github.com/usezombie/usezombie#contributing.contributing/*.mdxpages — live by direct URL but absent from nav andllms.txt(limbo state). Contributor docs now live in the repo README.Verification
gitleaks detect→ no leaks.docs.jsonvalidated as JSON; nav groups + global anchors confirmed.llms.txt/llms-full.txt→ 200; per-page.mdmirrors + contextual AI buttons present (docs site stays friendly to large language models)..mdxfiles.## Contributingheading is present in the live README onmain, so#contributingresolves.Session notes
npx skills addthe primary path, but the current live usezombie.com bundle has zeronpx/skills add— two commands only, with the npm install adding the skill. Indy confirmed the live site is authoritative. The historical May 17 changelog entry was left intact (archive, don't rewrite).zombiectlinstall mechanism locally — it isn't installed on this machine, so the "npm install adds the host skill" claim rests on the live-site copy + install animation, not a local run. Thecurlfallback covers the case if that's ever untrue.<Update>if a reviewer wants one.🤖 Generated with Claude Code
Documentation
Post-release
/document-releaseaudit of every.mdxpage against thezombiectl/server source and the live product. 11 files updated.Factual corrections
quickstart.mdx— login token order corrected to--token→ZOMBIE_TOKEN→ stdin (matcheslogin-helpers.ts).cli/configuration.mdx— auth precedence rewritten: TTY-aware command resolution (interactive prefersZOMBIE_TOKEN; CI prefers stored creds),--tokenis login-only not global; credentials path fixed to~/.config/zombiectl/credentials.json.cli/zombiectl.mdx— logout credentials path fixed (usezombie→zombiectl).cli/install.mdx—doctordocumented as 3 checks, no auth required (was 5 + an auth short-circuit; the table had drifted fromconstants/doctor-checks.ts).api-reference/introduction.mdx— error envelope corrected to flat RFC 7807application/problem+json(matcheserror-codes.mdx); IDs are UUIDv7.zombies/credentials.mdx—TRIGGER.mdexample uses thetriggers:array (singulartrigger:is rejected at install).zombies/troubleshooting.mdx+workspaces/overview.mdx— webhook URL gains the/{source}segment.zombies/overview.mdx— removed dead/concepts#creditsanchor.zombies/troubleshooting.mdx— fixed dead/quickstart#wire-the-github-webhookanchor.Free-trial framing (credit/wallet model preserved — it's the post-trial reality, pinned to
snippets/rates.mdx)billing/plans.mdx,billing/budgets.mdx— added "Free until July 31, 2026" banner + pricing link.workspaces/overview.mdx— softened tenant-wallet wording.Verification: gitleaks clean; no broken anchors/links;
docs.jsonvalid;changelog.mdxleft untouched (historical).Documentation debt
zombiectl workspace credentials— real command (redirect stub to the dashboard vault) listed in the command table but lacks a dedicated body section. Deferred; needs the exact dashboard path + credential-command naming confirmed before documenting.doctoras 5 checks; current source has 3. Left as historical record (archive, don't rewrite), but worth a glance ifdoctoris expected to exposetenant_provider/auth_token_present.Greptile Summary
This PR is a documentation cleanup pass: it syncs the install flow to the live two-command path (dropping the now-stale
npx skills addstep), adds free-trial framing across billing pages, corrects several factual drifts (credentials path, doctor check count, webhook URL shape, RFC 7807 error envelope,triggers:array syntax), removes four orphaned contributing pages (moved to the repo README), and tightens the landing page and concepts page.index.mdx,quickstart.mdx,cli/install.mdx,zombies/install.mdx):npm install -g @usezombie/zombiectlnow installs the host skill directly;npx skills adddropped;curlone-liner retained as a Tip fallback.billing/plans.mdx,billing/budgets.mdx,concepts.mdx,quickstart.mdx): credit/wallet model preserved for post-trial reality, execution described as free through July 31, 2026, with a pricing link replacing inline credit detail.cli/configuration.mdx,cli/install.mdx,cli/zombiectl.mdx,api-reference/introduction.mdx,zombies/credentials.mdx,zombies/troubleshooting.mdx,workspaces/overview.mdx): auth precedence rewritten, doctor shrunk from five to three checks, logout path fixed, RFC 7807 envelope corrected,TRIGGER.mdexample corrected totriggers:array, dead anchors replaced with valid ones.Confidence Score: 4/5
Safe to merge with one documentation inconsistency in cli/configuration.mdx that could mislead developers using env-var token overrides in scripts.
The auth-precedence section in cli/configuration.mdx advises using the env var for one-off token overrides in scripts, but the same page documents that non-interactive mode (which scripts are) gives stored credentials priority over the env var. A developer with a local credentials file who sets the env var expecting it to override would find it silently ignored — the documentation tells them two contradictory things in adjacent sentences.
cli/configuration.mdx — the non-interactive precedence rule and the script-override advice are in conflict and should be reconciled before merging.
Important Files Changed
Sequence Diagram
sequenceDiagram actor Dev as Developer participant CLI as zombiectl (npm -g) participant Skill as /usezombie-install-platform-ops participant API as usezombie API participant GH as GitHub Dev->>CLI: "npm install -g @usezombie/zombiectl" Note over CLI: Installs /usezombie-* host skills into detected agent directories Dev->>CLI: zombiectl login CLI-->>Dev: Browser device flow → 6-digit code Dev->>CLI: (types code) CLI->>API: Exchange code → store credentials API-->>CLI: Workspace provisioned, credentials.json written Dev->>Skill: /usezombie-install-platform-ops Skill->>CLI: zombiectl install --from ~/.config/usezombie/samples/platform-ops Skill-->>Dev: 3 gating questions (Slack, branch glob, cron) Skill->>GH: gh api repos/.../hooks (register webhook) GH-->>Skill: hook_id + HMAC self-verify ok Skill-->>Dev: Prints per-trigger registration summary Note over Dev,GH: curl one-liner replaces npm install step as a fallbackComments Outside Diff (1)
concepts.mdx, line 102-104 (link)The "Budget" accordion describes
daily_dollarsandmonthly_dollarsas dollar ceilings on hosted execution that "stop new stages from opening" when hit, but nowhere in the accordion (or in the new free-trial prose above it) is it clarified that these ceilings apply to the post-trial metered rate. A user reading this during the trial period may set a tight budget and be surprised when their zombie stops running even though execution shows as free.Prompt To Fix With AI
Prompt To Fix All With AI
Reviews (5): Last reviewed commit: "docs(concepts): clarify budget ceilings ..." | Re-trigger Greptile