Skip to content

Document stopping and restarting agent work - #60

Open
justin808 wants to merge 3 commits into
mainfrom
jg-codex/restart-recovery-docs
Open

justin808 wants to merge 3 commits into
mainfrom
jg-codex/restart-recovery-docs

Conversation

@justin808

@justin808 justin808 commented Sep 9, 2026

Copy link
Copy Markdown
Member

Operators may need to restart before every agent produces a handoff. Add a public guide covering immediate restart, one shared grace deadline, and recovery from checkpoints, newer logs, and live state. Link it from the docs index and site footer.

The guide distinguishes the workflow from host guarantees and automatic recording. It preserves existing authority, ownership, pauses and budgets, and contains no private task history.

Validation: npm test passed (build, adoption-ladder checks, and 272 internal links across 12 pages); rendered page inspected in the browser. Package installation reported existing dependency advisories; dependency versions are unchanged.

The source-pack implementation is a companion change; the page directs readers to check their installed revision before relying on newer helpers. Production publication follows the repository's normal main-branch deployment.

Companion source implementation: shakacode/agent-workflows#800 . The guide now also covers task/filename identity, current-generation recovery acknowledgments, and restart-only holds versus prior pauses.

@github-actions github-actions Bot added the coderabbit:first-pass Triggers CodeRabbit's automatic first-pass pull-request review. label Sep 9, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-09T06:41:25.852451Z 4e2c04c New commits
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 4bbab082-3a82-4f25-bc71-1394ee1535b1


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

meaningful step finishes, or work enters an external wait. For consequential
operations, record intent before execution and the result afterward.

The source pack's [restart and recovery procedure](https://github.com/shakacode/agent-workflows/blob/main/docs/agent-runner-restarts.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This links to agent-workflows/blob/main/docs/agent-runner-restarts.md, but the PR description says "the source-pack implementation is a companion change" — i.e. this file may not exist in main of agent-workflows yet. If that companion PR hasn't merged first, this ships a dead link. Also worth noting: scripts/check-links.mjs explicitly only validates internal links ("this script never touches the network, so it cannot and does not check external links" — see its header comment), so npm test passing does not prove this URL resolves. Worth confirming the companion doc is live before/at merge time.

Mirror or back up separately for disk-loss protection. Do not commit raw task
transcripts, credentials, or private operation details to public repositories.

Codex documents its [session transcript and app log locations](https://developers.openai.com/codex/app/troubleshooting/).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This page adds several developers.openai.com/codex/... links (here, and lines 91 and 98). Like the agent-workflows link above, these are external URLs that scripts/check-links.mjs cannot and does not check (it's documented as offline/internal-only). If any of these paths are wrong or move, the site's npm test will still pass silently. Worth a manual click-through before merge, and periodically afterward, since nothing in CI will catch drift here.

Reaching a usage limit is different from quitting the app. OpenAI says an
active turn can continue after reaching usage limits, subject to fair use.
That does not guarantee completion of every goal, queued turn or future worker.
See the current [OpenAI usage guidance](https://developers.openai.com/codex/pricing/#what-happens-when-you-hit-usage-limits). Recovery instructions should

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This links to an external page with a #what-happens-when-you-hit-usage-limits fragment. scripts/check-links.mjs (per its own header comments) only checks internal links and explicitly never touches the network, so if OpenAI restructures/renames that page or heading, this link (and the other three new external links in this file: lines 72, 83, 99) will 404 or land on the wrong anchor silently, with no CI signal.

Failure scenario: OpenAI reorganizes developers.openai.com/codex/pricing (product docs churn is common), the fragment or page moves, and the doc keeps citing stale/dead evidence for a specific behavioral claim about usage limits — readers get a broken citation with no automated check ever catching it.

meaningful step finishes, or work enters an external wait. For consequential
operations, record intent before execution and the result afterward.

The source pack's [restart and recovery procedure](https://github.com/shakacode/agent-workflows/blob/main/docs/agent-runner-restarts.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This links to github.com/shakacode/agent-workflows/blob/main/docs/agent-runner-restarts.md, a filename not referenced anywhere else in this repo. Since this docs site and the agent-workflows source pack are separate repos, if the companion doc hasn't landed on main of agent-workflows yet (or lands under a different filename), this is a dead link at merge time and stays that way, since check-links.mjs only validates internal links and skips all http(s): targets.

Failure scenario: this PR merges before (or without) a matching agent-runner-restarts.md file existing in shakacode/agent-workflows, so the "restart and recovery procedure" link 404s for every reader with no build/CI failure to catch it.

@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: 4e2c04c28d

ℹ️ 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 on lines +15 to +19
| Time available | What to do | What to expect |
| --- | --- | --- |
| None | Restart and recover afterward. | The last operation may have an uncertain result. |
| A little | Stop new work and allow one shared grace period, normally 60 seconds. | Some tasks may not acknowledge in time. |
| Planned maintenance | Choose a longer deadline for handoffs and known sensitive operations. | More complete evidence, with no guarantee against a crash. |

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 Make the new comparison table responsive

At narrow viewport widths or with increased browser text size, this three-column table can exceed the document width because each column contributes its longest unbreakable word to the table's intrinsic minimum width. The global stylesheet provides no responsive or overflow treatment for .doc-body table, while .doc reserves 48px for horizontal padding, so the table can force page-level horizontal scrolling. Add a responsive table treatment, such as contained horizontal overflow or cell word wrapping.

Useful? React with 👍 / 👎.

@claude

claude Bot commented Sep 9, 2026

Copy link
Copy Markdown

Code Review Summary

Reviewed this PR (docs: purely additive — new /docs/restarts/ page plus matching footer nav and docs index links across src/layouts/Base.astro, src/pages/docs/index.md, and src/pages/docs/restarts.md).

No issues found.

  • Routing checks out: the new page maps correctly to /docs/restarts/.
  • New links are placed consistently in both the footer nav and docs index (same relative position in both lists).
  • Frontmatter shape matches other doc pages (layout, title, eyebrow, description).
  • GFM table syntax is already used elsewhere in the docs, so no rendering risk.
  • No internal markdown links inside the new page to break.
  • External links (GitHub repo, OpenAI docs) couldn't be live-checked in this session, but that's outside the scope of this diff and outside what the repo's own link checker covers.

🤖 Generated with Claude Code

This branch was successfully deployed

1 active deployment
preview 4e2c04c2 Deployed Sep 9, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

coderabbit:first-pass Triggers CodeRabbit's automatic first-pass pull-request review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant