docs: enhance interface & conversations chapters - #36
Conversation
- Add YAML frontmatter to 07-feature-entry.md - Add SVG diagrams: three-column layout, context lifecycle, rewind branch - Enhance 07-markdown-rendering with rendering examples and troubleshooting - Enhance 08-exporting-conversations with detailed operation steps - Enhance 09-context-control with practical guidance and /new vs /compact comparison - Enhance 10-rewind-checkpoints with branch mechanism explanation - Insert image references in layout-overview, context-control, rewind-checkpoints
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6b93afb243
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| ``` | ||
|
|
||
| :::tip 安全网 | ||
| 因为旧分支始终保留,Rewind 是一个低风险操作。即使回撤后新路径也不理想,你可以再次 Rewind 回到更早的检查点,或者查看旧分支中的内容作为参考。 |
There was a problem hiding this comment.
Qualify the claim that Rewind checkpoints are always retained
For users who configure checkpoint retention or clean archived data, this safety guarantee is false: docs/05-more/10-changelog/v10.0.89.md documents configurable retention periods and one-click cleanup of archived checkpoint data. After such cleanup, an earlier checkpoint may no longer be available for another Rewind, so this should state that recovery depends on the configured retention and cleanup policy rather than promising that old branches are always retained.
Useful? React with 👍 / 👎.
修复 PR #35 审核反馈: - 删除误提交的 PLAN-interface-conversations.md - 还原 interface/conversations/super-document/memory/capabilities/email/ concepts/more/faq 章节至 origin/main(由 PR #36/#38 各自负责) - 移除 .drawio 源文件(keyboard-shortcuts-overview, data-flow-diagram) - 移除不属于本 PR 的 static/img 图片文件 - 移除 FAQ 中越界新增的 07-delegation.md、08-automation.md 本 PR 现仅包含 user-guide/06-agents/ 和 03-teaching/ 的内容增强。
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 657920f7a2
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| <!-- Info box --> | ||
| <rect x="60" y="210" width="580" height="75" rx="8" fill="rgba(255,255,255,0.03)" stroke="rgba(255,255,255,0.1)" stroke-width="0.5"/> | ||
| <text x="80" y="235" fill="#e0e0e0" font-size="11" font-weight="500">关键特性</text> | ||
| <text x="80" y="255" fill="#94a3b8" font-size="9">• 旧分支(绿色)始终保留,不会被删除</text> |
There was a problem hiding this comment.
Qualify retained-branch claim in the diagram
For users who configure checkpoint retention or run the cleanup added in docs/05-more/10-changelog/v10.0.89.md:14, this embedded diagram text is still misleading even if the Markdown copy is fixed: the SVG itself promises old branches are “always retained” and “won’t be deleted,” so published docs would continue telling users they can rely on a checkpoint/branch that may have been purged by policy. Fresh evidence beyond the existing comment is that the newly added SVG bakes the same unconditional guarantee into the image asset.
Useful? React with 👍 / 👎.
变更内容
完善用户指南「界面导航」和「对话管理」两个章节。
Interface 章节
07-feature-entry.md添加 YAML frontmatter(title/description/keywords)01-layout-overview.md中引用Conversations 章节
07-markdown-rendering.md:新增渲染效果示例(代码块、表格、Mermaid、公式)和渲染异常处理表格08-exporting-conversations.md:新增详细操作步骤(完整导出 + 多选导出)09-context-control.md:新增实践建议表格、/new vs /compact 选择指南、记忆不受压缩影响说明;新增上下文生命周期 SVG 图10-rewind-checkpoints.md:新增分支机制详细说明和 SVG 示意图新增图片
static/img/user-guide/interface/three-column-layout.svgstatic/img/user-guide/conversations/context-lifecycle.svgstatic/img/user-guide/conversations/rewind-branch.svg质量说明