Skip to content

docs: fix stale service table/route, add WARM_IDLE_TIMEOUT_SECS, refresh cap list - #158

Merged
xmiksay merged 1 commit into
masterfrom
154-docs-audit-stale-git_services-table__route-in-brie
Jul 3, 2026
Merged

xmiksay merged 1 commit into
masterfrom
154-docs-audit-stale-git_services-table__route-in-brie

Conversation

@xmiksay

@xmiksay xmiksay Bot commented Jul 3, 2026

Copy link
Copy Markdown

Documentation audit fixes from #154. Docs-only — no runtime behavior changes (one Rust doc-comment edit; make check green).

D1 — brief references renamed git_services table / route

.claude/CLAUDE.md Configuration section named the pre-rename git_services table and a /api/git_services route that no longer exists. The table was renamed to service (m20260609_000021_rename_git_services_to_service.rs, entity/service.rs) and the route is /api/services (main.rs:188). README and architecture.md were already correct — only the brief had drifted.

D2 — WARM_IDLE_TIMEOUT_SECS missing from README / .env.example

config.rs reads it (default 1800, 0 = disabled) and it changes operator-visible behavior — warm sessions are evicted after 30 min idle. Added it to the README env table and .env.example (both claim to be the copy-into-.env reference; all other 13 vars were present).

D3 — file-size-cap paragraph in .claude/CLAUDE.md stale

  • Dropped src/agent/claude.rs (now 383 lines, under cap) from the tests-only list.
  • Added src/models/store.rs (419, #[cfg(test)] at 362) — the over-400-due-to-tests category.
  • Moved src/jobs/store.rs to the genuinely-over-cap note (production half ~421, #[cfg(test)] at 422).
  • Added frontend/src/types/api.ts (478 production TS) to the over-cap inventory.

Also

  • docs/architecture.md: added a module-map row for src/provider/retry.rs (send_with_retry + backoff, used by both provider clients).
  • src/entity/tasks.rs: task_state doc-comment now lists all six values (added paused + released).

Closes #154

…esh cap list

What: Correct operator-facing docs drift — the renamed service table/route, the
missing WARM_IDLE_TIMEOUT_SECS var, the stale file-size-cap inventory, a missing
module-map row, and an incomplete task_state doc-comment.

Why: The brief still named the pre-rename `git_services` table and a
`/api/git_services` route that no longer exists; README and .env.example (the
copy-into-.env references) omitted WARM_IDLE_TIMEOUT_SECS, hiding the 30-min
warm-session eviction default from operators; the cap list named claude.rs
(now 383 lines, under cap) and omitted models/store.rs and api.ts; the module
map had no retry.rs row; tasks.rs listed only 4 of the 6 task_state values.

How:
- .claude/CLAUDE.md: git_services -> service table, /api/git_services ->
  /api/services; drop claude.rs from the tests-only over-cap list, add
  models/store.rs, note api.ts + jobs/store.rs production half are genuinely
  over the cap.
- README.md + .env.example: add WARM_IDLE_TIMEOUT_SECS (default 1800, 0 = off).
- docs/architecture.md: add src/provider/retry.rs module-map row.
- src/entity/tasks.rs: task_state doc-comment now lists paused + released.
@xmiksay
xmiksay merged commit 3bd3c80 into master Jul 3, 2026
2 checks passed
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.

Docs audit: stale git_services table/route in brief, WARM_IDLE_TIMEOUT_SECS missing from README/.env.example, file-cap list drift

1 participant