docs(quoter-bot): make readme user oriented, split operator reference - #161
Conversation
Rewrite the quoter-bot README as a user guide with four sections: description (reference-bot disclaimer), get started (local pnpm and Docker paths only), setup (env vars, ladder strategy, bootstrap and ladder parameters), and roadmap. The previous README was a dense operator document; its full content (command catalog, Railway deployment, field-level validation rules, worked examples, playground details) moves unchanged to docs/reference.md with relative links fixed for the new location. architecture.md now points at both documents. Pre-commit knip fails in this .claude/worktrees checkout even on the clean base commit while the same tree passes in a regular checkout; hook bypassed for this docs-only change after running oxfmt and repo-wide lint manually. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@prd-carapulse[bot] can you review and approve if all good |
|
❌ Changes requested on PR #161. • Blocker: |
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep them coming! Reviewed commit: ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
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". |
![prd-carapulse[bot]](https://avatars.githubusercontent.com/in/2960675?s=60&v=4){kind=small}
There was a problem hiding this comment.
Blocking: CI Test fails in bots/quoter-bot/test/playground/model.test.ts because the rewritten README no longer contains the required argv-secret warning (--private-key <key>, MAKER_PRIVATE_KEY, --password <password>). The test is an explicit documentation/security contract.
Please either keep a concise warning in the user README or deliberately update the test to validate the warning in docs/reference.md, then rerun CI. Other checks pass; diff/link checks found no additional issues.
test/playground/model.test.ts pins this security note as a README contract; keep it in the user guide's setup section. Hook bypassed for the same environmental worktree knip failure as the previous commit; the guarded test file passes locally (22/22).
|
@prd-carapulse[bot] can you review and approve if all good |
|
@codex review |
|
✅ Approved PR #161 at • Previous README security-warning blocker fixed |
There was a problem hiding this comment.
Re-reviewed current head e60534cd69cda902f07456bc102ebb943d34f018. Previous blocker is fixed: the README retains the argv secret-exposure warning, and Test now passes.
Checked the full documentation move, user-guide accuracy against package scripts/config, relative links, and git diff --check; no remaining blocking findings. Lint, Typecheck, Test, and Dead-Code are green.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Main split the quoter-bot README into a user-oriented page plus docs/reference.md (PR #161) and landed cross-book quoting fixes. The README conflict is resolved to main's structure; this branch's operator Docker section (build, env/YAML runs, compose contract, keystore/AWS passthrough, Docker Hub release pipeline) moves into docs/reference.md between Deploy and Configuration with links re-depthed for docs/. The README's Docker quickstart now matches the merged YAML-first compose (main's text described its removed env-only compose), points to the reference for depth, and the roadmap bullet no longer lists container images as future work — they ship on every release via this PR. The six doc-contract test pins follow the moved content to reference.md. Committed with --no-verify: the pre-commit knip hook false-positives in this .claude/worktrees checkout location (CI Dead-Code is the gate). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 participant
What
bots/quoter-bot/README.mdas a user-oriented guide with four sections:docker build).bots/quoter-bot/docs/reference.md, with relative links fixed for the new location and the two duplicated playground sections merged.bots/quoter-bot/docs/architecture.mdto point at both documents.Why
The README had accreted into a ~780-line operator reference that buried the basics — what the bot is, that it is a reference implementation, and how to get it running. Newcomers now get a short guide; operators keep the complete reference one link away. No documentation was deleted.
Review notes
test/playground/model.test.tspins the argv secret-exposure warning as a README security contract, so that warning now lives in the README's Setup section as well as the reference (caught by CI on the first push, fixed ine60534c).pnpm formatapplied,pnpm lintclean, and every relative link in the three touched files was script-checked to resolve.--no-verify: the pre-commitknipstep fails in the.claude/worktreescheckout even on the clean base commitf49cdd3(verified by stashing all changes), while the identical tree passes knip in a regular checkout — an environmental quirk of nested git worktrees, unrelated to this diff. lint-staged (oxfmt) over these files runs clean; CI remains the arbiter here.🤖 Generated with Claude Code