improvement: document DB-vs-engine reconcile + log retention (v0.2.2 followup)#51
Merged
Gumbees merged 1 commit intoMay 26, 2026
Conversation
…followup) PR #50 fixed the reconcile-loop regression and added log retention but didn't update the architecture/readme docs. Adds the missing sections. ARCHITECTURE.md: - New "### DB-vs-Engine Reconcile" subsection under Watch Engine, explaining the 2s reconcile pass, the path.exists() filter that PR #50 added (the load-bearing fix for the v0.2.2-rc bug), and the missing-folder warn-once throttle. - New "### Log Retention" subsection under File Layout, covering the prune_logs() function, the 1 GiB cap, never-delete-today, startup + hourly invocation, and the rationale for the cap value. README.md: - One paragraph in the Configuration section explaining the daily rotation + 1 GiB retention cap. No code changes; docs only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PR #50 (v0.2.2 bug fix for #49) shipped the reconcile-loop fix and log retention but didn't touch
ARCHITECTURE.mdorREADME.md. Closing the doc gap.ARCHITECTURE.md
### DB-vs-Engine Reconcilesubsection under Watch Engine ... explains the 2s reconcile pass, thepath.exists()filter (the load-bearing fix that prevents the every-2s restart cycle when a stale DB row points at a missing path), and the missing-folder warn-once throttle.### Log Retentionsubsection under File Layout ... documentsprune_logs(dir, cap), the 1 GiB cap, never-delete-today-rule, startup + hourly invocation, and the cap rationale.README.md
Why not bundled into PR #50
The agent that implemented #49 focused on code + tests and skipped the surrounding docs. Catching that gap with a small follow-up rather than rebasing #50 — same end state, less churn.
Test plan
🤖 Generated with Claude Code