Skip to content

fix: resolve #69#71

Closed
duongynhi000005-oss wants to merge 1 commit into
usezombie:mainfrom
duongynhi000005-oss:fix-issue-69-1780028570
Closed

fix: resolve #69#71
duongynhi000005-oss wants to merge 1 commit into
usezombie:mainfrom
duongynhi000005-oss:fix-issue-69-1780028570

Conversation

@duongynhi000005-oss
Copy link
Copy Markdown

@duongynhi000005-oss duongynhi000005-oss commented May 29, 2026

Fix for #69\n\nImplemented the docs cleanup for issue #69.\n\nChanged:\n- index.mdx: tightened landing copy, removed time estimate, switched append-only wording to \u201cactivity stream.\u201d\n- quickstart.mdx: removed stale time estimate, simplified pricing trial copy, kept the two-command install flow.\n- cli/install.mdx and [zombies/install.mdx](/tmp/bounty-docs_69-u6ruuy\n\nPlease review and let me know if any changes are needed.

Greptile Summary

This PR aligns the docs with the current product terminology and install flow: it renames "stage" → "execution" and "event stream" → "activity stream" in concepts.mdx, removes stale time estimates from the quickstart and landing page, and adds a changelog entry for the changes.

  • concepts.mdx — systematic rename of "stage" → "execution" throughout; the linked page concepts/context-lifecycle.mdx was not updated and still uses "stage" everywhere, creating a terminology mismatch for readers who follow the link.
  • changelog.mdx — adds a May 29, 2026 Update block; one bullet ("Contributing link moves to GitHub") describes a docs.json nav change not present in this PR's changeset.
  • index.mdx, quickstart.mdx, cli/install.mdx, zombies/install.mdx — minor copy tightening with no correctness issues.

Confidence Score: 3/5

The four minor-copy files are safe, but concepts.mdx introduces a terminology mismatch by renaming the local glossary without updating the linked context-lifecycle page, and the changelog records a nav change that did not happen in this PR.

The stage→execution rename in concepts.mdx is incomplete: the Execution accordion links to /concepts/context-lifecycle with the text 'How long does an execution take?' but the target page still opens with the heading 'How long does a stage take?' and uses 'stage' throughout. The changelog also claims a nav change that docs.json does not reflect.

concepts/context-lifecycle.mdx (must be updated to complete the stage→execution rename) and changelog.mdx line 35 (contributing-link bullet).

Important Files Changed

Filename Overview
concepts.mdx Renames 'stage' → 'execution' and 'event stream' → 'activity stream' throughout, but the linked page concepts/context-lifecycle.mdx was not updated, creating a terminology mismatch.
changelog.mdx Adds May 29, 2026 Update block; one bullet describes a docs.json nav change not present in this PR's changeset.
index.mdx Switches description to 'activity stream', trims the 2am-problem paragraph, removes the time estimate — consistent with AGENTS.md style rules.
quickstart.mdx Removes time estimate and '(event receipts + stages)' parenthetical; minor wording improvements. No correctness issues.
cli/install.mdx Replaces 'runs three checks' / 'every check runs and reports' with 'performs' / 'every check completes and reports' — cosmetic wording only.
zombies/install.mdx Simplifies the idempotency sentence — no information loss, no issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
    A[concepts.mdx
stage to execution
event stream to activity stream] -->|links to| B[concepts/context-lifecycle.mdx
still titled
How long does a stage take?]
    style B fill:#f87171,color:#fff
    A --> C[index.mdx
activity stream
no time estimate]
    A --> D[quickstart.mdx
no time estimate
simplified pricing copy]
    A --> E[cli/install.mdx
minor wording]
    A --> F[zombies/install.mdx
minor wording]
    G[changelog.mdx
May 29 2026 entry] -->|claims nav change| H[docs.json
not modified by this PR]
    style H fill:#f59e0b,color:#fff
Loading
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
concepts.mdx:76
**Stale link target after stage→execution rename**

The "Execution" accordion now reads "See [How long does an execution take?](/concepts/context-lifecycle)" but `concepts/context-lifecycle.mdx` still carries the title "How long does a stage take?" and uses "stage" in every heading, table, and paragraph. A reader who clicks through will immediately land on conflicting terminology — "stage" throughout, despite just reading that the unit is called an "execution." The linked page needs the same rename pass applied here in `concepts.mdx`.

### Issue 2 of 2
changelog.mdx:35
**Changelog entry describes a change absent from this PR**

"Contributing link moves to GitHub — the docs nav now points contributors to the repo README's contributing section." `docs.json` already contains `"href": "https://github.com/usezombie/usezombie#contributing"` and was not modified by this PR. Either the nav change was made in an earlier PR (making this bullet inaccurate), or it is still pending (meaning it should be a follow-up task, not a committed changelog entry).

Reviews (1): Last reviewed commit: "fix: #69 - patch affected code" | Re-trigger Greptile

Greptile also left 2 inline comments on this PR.

Comment thread concepts.mdx
<Accordion title="Stage">
One end-to-end execution of the agent on one trigger: webhook arrives → agent reasons → tool calls → result. Most zombies finish a stage in a few seconds. See [How long does a stage take?](/concepts/context-lifecycle).
<Accordion title="Execution">
One billable agent reasoning window for one event: webhook arrives → agent reasons → tool calls → result. See [How long does an execution take?](/concepts/context-lifecycle).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Stale link target after stage→execution rename

The "Execution" accordion now reads "See How long does an execution take?" but concepts/context-lifecycle.mdx still carries the title "How long does a stage take?" and uses "stage" in every heading, table, and paragraph. A reader who clicks through will immediately land on conflicting terminology — "stage" throughout, despite just reading that the unit is called an "execution." The linked page needs the same rename pass applied here in concepts.mdx.

Prompt To Fix With AI
This is a comment left during a code review.
Path: concepts.mdx
Line: 76

Comment:
**Stale link target after stage→execution rename**

The "Execution" accordion now reads "See [How long does an execution take?](/concepts/context-lifecycle)" but `concepts/context-lifecycle.mdx` still carries the title "How long does a stage take?" and uses "stage" in every heading, table, and paragraph. A reader who clicks through will immediately land on conflicting terminology — "stage" throughout, despite just reading that the unit is called an "execution." The linked page needs the same rename pass applied here in `concepts.mdx`.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment thread changelog.mdx
## CLI

- **Two-command install path** — quickstart, CLI install, and zombie install pages remove the stale `npx skills add usezombie/skills` step. The `curl -fsSL https://usezombie.sh | bash` one-liner remains as the fallback path.
- **Contributing link moves to GitHub** — the docs nav now points contributors to the repo README's contributing section.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Changelog entry describes a change absent from this PR

"Contributing link moves to GitHub — the docs nav now points contributors to the repo README's contributing section." docs.json already contains "href": "https://github.com/usezombie/usezombie#contributing" and was not modified by this PR. Either the nav change was made in an earlier PR (making this bullet inaccurate), or it is still pending (meaning it should be a follow-up task, not a committed changelog entry).

Prompt To Fix With AI
This is a comment left during a code review.
Path: changelog.mdx
Line: 35

Comment:
**Changelog entry describes a change absent from this PR**

"Contributing link moves to GitHub — the docs nav now points contributors to the repo README's contributing section." `docs.json` already contains `"href": "https://github.com/usezombie/usezombie#contributing"` and was not modified by this PR. Either the nav change was made in an earlier PR (making this bullet inaccurate), or it is still pending (meaning it should be a follow-up task, not a committed changelog entry).

How can I resolve this? If you propose a fix, please make it concise.

@indykish
Copy link
Copy Markdown
Contributor

indykish commented Jun 1, 2026

Thanks for the contribution. I’m going to close this because #69 was an already-merged PR rather than an open issue, and this PR appears to re-apply part of that work while introducing some docs drift against the current state.

If you’d like to contribute, please pick an open issue and keep the PR scoped to that issue. We appreciate the effort.

@indykish indykish closed this Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants