Skip to content

docs: simplify workflow documentation - #103

Merged
Honguan merged 1 commit into
mainfrom
agent/docs-simplification
Aug 3, 2026
Merged

docs: simplify workflow documentation#103
Honguan merged 1 commit into
mainfrom
agent/docs-simplification

Conversation

@Honguan

@Honguan Honguan commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • condense the Chinese and English README workflow documentation
  • merge recovery, escalation, and PLAN.md lifecycle into one concise contract section
  • replace repeated prose with a four-stage flow table
  • retain operational details while removing low-level repetition

Images and workflow implementation are unchanged.

Validation

  • npm test — 94/94 passed
  • npm run check — passed
  • git diff --check — passed

@Honguan
Honguan marked this pull request as ready for review August 3, 2026 10:31
@Honguan
Honguan merged commit 64fcb0b into main Aug 3, 2026
13 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8d0ba36494

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.en.md
Reasoning values: `none`, `low`, `medium`, `high`, `xhigh`, `max`.

Fast and reasoning are independent settings, retained only for the same child role; neither affects the primary nor another role. Run `npx codex-model-router@latest status [--global]` to view configured and effective values. Codex currently exposes no per-agent Fast runtime control, so `configured=true` explicitly reports `effective=not-supported`; the installer never enables global `fast_mode` or maps Fast to reasoning.
Fast and reasoning are independent and retained only for the same child role. Use `status [--global]` to view them; Codex currently has no per-child Fast runtime control, so `configured=true` reports `effective=not-supported`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore the executable in the status command

For users who installed the router through the documented npx invocation, status is not a standalone executable—the package exposes codex-model-router, and install does not install that binary globally. Following this shortened instruction therefore produces a shell command-not-found error; retain the runnable form npx codex-model-router@latest status [--global].

Useful? React with 👍 / 👎.

Comment thread README.en.md
## Plan-artifact lifecycle
| Stage | Flow | PLAN.md owner |
| --- | --- | --- |
| `INITIAL` | Primary confirms → Luna reads/executes → Terra plans/reviews | Current writable executor |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Put planning before execution in the INITIAL flow

When readers use this table to understand the workflow order, the arrows now say that Luna executes before Terra plans. The installed workflow instead collects Luna's evidence, has Terra produce the plan, then has the same Luna persist/reread and implement it before Terra verifies; present those as separate ordered steps rather than grouping reads/executes ahead of plans/reviews.

Useful? React with 👍 / 👎.

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.

1 participant