docs: consolidate Codex onboarding - #1251
Open
chenncy wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates Codex onboarding documentation by removing duplicated setup steps from READMEs, adding dedicated pages that distinguish durable Memory from temporary Handoff workflows, and keeping the English/Chinese docs and navigation in sync (as part of #1226’s documentation restructure).
Changes:
- Update site navigation to include new “Memory and Handoff” explanation and “Hand off work in Codex” how-to pages (EN + ZH).
- Trim root and integration READMEs to point to the canonical docs instead of duplicating onboarding steps.
- Refresh Codex quickstart, docs overview, and install/config pages to reflect the Memory vs Handoff boundary and link to the new pages.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
zensical.toml |
Adds EN/ZH nav entries for the new Memory/Handoff and handoff workflow pages. |
README.md |
Replaces duplicated Codex setup guidance with pointers to the canonical docs quickstart/overview. |
integrations/codex/README.md |
Keeps the plugin README implementation-focused and links to user docs for setup/troubleshooting. |
docs/en/docs/tutorials/codex-quickstart.md |
Reframes the tutorial around durable Memory across sessions and links to the new Handoff docs. |
docs/en/docs/index.md |
Updates the docs landing page “path” bullets, including Memory vs Handoff guidance and the new how-to. |
docs/en/docs/how-to/install-and-run.md |
Removes duplicated plugin command snippet and points to Configure Codex; clarifies readiness/doctor guidance. |
docs/en/docs/how-to/configure-codex.md |
Expands the conceptual section to cover automatic recall, Memory, and Handoff, with links to the new pages. |
docs/en/docs/how-to/handoff-with-codex.md |
New how-to describing the explicit Handoff workflow and when to keep it temporary vs durable. |
docs/en/docs/explanation/memory-and-handoff.md |
New explanation page defining Memory vs Handoff and when to use each. |
docs/zh/docs/tutorials/codex-quickstart.md |
Updates the quickstart narrative to focus on cross-session Memory maintenance and links to the new pages. |
docs/zh/docs/index.md |
Reworks the docs landing page “path” bullets, including Memory vs Handoff guidance and the new how-to. |
docs/zh/docs/how-to/install-and-run.md |
Removes duplicated plugin command snippet and points to Configure Codex; clarifies readiness/doctor guidance. |
docs/zh/docs/how-to/configure-codex.md |
Expands the conceptual section to cover automatic recall, Memory, and Handoff, with links to the new pages. |
docs/zh/docs/how-to/handoff-with-codex.md |
New how-to describing the explicit Handoff workflow and when to keep it temporary vs durable. |
docs/zh/docs/explanation/memory-and-handoff.md |
New explanation page defining Memory vs Handoff and when to use each. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
71
to
74
| Start a third session and ask: | ||
|
|
||
| > List the active PowerContext memory for this project. | ||
|
|
Comment on lines
+30
to
+32
| Codex captures a concise current-state Source and activates the Handoff. Inspect the generated Draft and correct | ||
| missing, stale, or unsupported statements. A repeated boundary can return `ignored`, which means that Source has | ||
| already been used. |
…ding-zh # Conflicts: # README.md # docs/en/docs/how-to/install-and-run.md # docs/en/docs/index.md # docs/zh/docs/how-to/install-and-run.md # docs/zh/docs/index.md # zensical.toml
Author
|
Conflicts are resolved and Could a maintainer approve the pending workflows and review the PR when available? |
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.
Part of #1226
Summary
Validation
uv run zensical build -sAI usage