Skip to content

docs: keep one agent guide and correct the retired FTWDB note - #1364

Open
frahlg wants to merge 1 commit into
masterfrom
docs/one-agents-guide
Open

frahlg wants to merge 1 commit into
masterfrom
docs/one-agents-guide

Conversation

@frahlg

@frahlg frahlg commented Sep 23, 2026

Copy link
Copy Markdown
Member

Summary

  • Removes CLAUDE.md. AGENTS.md is the only agent guide, and it already matches the product rules in VISION.md: local planning, Core validates before hardware, novice default with expert access, beta then stable, no edge channel.
  • Corrects docs/ftwdb-shadow.md and the retired -ftwdb-shadow-socket help text. They said DuckDB owns history. Current Core and the architecture doc store history in SQLite. DuckDB remains only the offline converter for boxes that once selected it.
  • Leaves the retired-path warnings in place (upgrade-from-legacy.md, upgrade-paired-release.md, rpi-image.md). They still tell operators not to use those installers.
  • Does not edit the Jev paragraphs in PR #1292. That PR adds to AGENTS.md in a different section.

Test

Documentation and a retired flag's help string. No behavior change beyond the help text.

CLAUDE.md only pointed at AGENTS.md. The agent rules now stand on their
own. The FTWDB page and the retired socket flag claimed DuckDB stores
history; current Core stores it in SQLite.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 23, 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-23T15:00:33.422903Z c88fe8b PR opened
ℹ️ 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.

@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: c88fe8bed5

ℹ️ 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 CLAUDE.md
@@ -1,3 +0,0 @@
@AGENTS.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.

P2 Badge Keep the Claude entrypoint that imports AGENTS.md

In standard Claude Code sessions opened at this checkout, project instructions are discovered through CLAUDE.md, not the newly asserted sentence in AGENTS.md; deleting this import therefore causes Claude to miss the repository's safety, release, and coordination rules. Retain the small @AGENTS.md shim so Claude actually follows the sole canonical guide.

AGENTS.md reference: AGENTS.md:L274-L274

Useful? React with 👍 / 👎.

@miravoss26 miravoss26 left a comment

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.

Docs and comment cleanup: removes the root CLAUDE.md, rewords the FTWDB retirement notes to say history lives in SQLite, and updates the help string on the retired -ftwdb-shadow-socket flag. The only code touched is that flag description.

  • [blocking, CI is red because of this] contract/push-catalogue.yaml:5: this edits a comment in a file that lives byte-identical in the app repo. The "registry has not drifted from the app" check fails on a real diff: the app's copy still says "stated in CLAUDE.md since the beginning". The check's own instruction is to change both copies in a pair of PRs and rerun go generate ./internal/.... Either drop this hunk here, or make the same edit in the app repo in a paired PR.
  • [question] AGENTS.md:274, CLAUDE.md: as far as I know Claude Code loads CLAUDE.md, not AGENTS.md. With the root CLAUDE.md gone, does a Claude session in this repo still pick up these rules? The new sentence says Claude follows AGENTS.md directly, so worth confirming.
  • Verified: the doc claim that release builds have no DuckDB dependency holds, go.mod has no duckdb on this branch or on the default branch. The new link to docs/history-conversion.md resolves. Security screen clean.

Needs a human decision on the paired file before this can go green. The rest reads correct.

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