Repository navigation
docs: simplify installation and operator guidance - #326
Conversation
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords: 2
Please check the settings in the CodeRabbit UI or the
|
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
Reviewed the PR at f0a1114, with full attention to the shipped Compose/ENV examples and tests, which operators run as-is. The docs/ and openspec/ regions are documentation, so I read them only selectively.
- Single-account
compose.yaml: onlyibkr-sync-individualremains. It keeps the hardening (read_only,cap_drop,10001:10001, tmpfs) and the${VAR:?...}credential interpolation. It addsLOG_LEVEL,APPRISE_URLSandAPPRISE_TIMEOUTpass-through and a configurable external network name. compose.multi-account.yaml: carries the previous two-service layout with separate state directories and staggeredCRONdefaults.CRONnever resolves empty..env.example,.dockerignore,.gitignore: the notification and network defaults are valid forconfig.py(blank or[]APPRISE_URLSmeans off).DRY_RUN=truestays the default. The Dockerfile copies no.env*file, so the.dockerignoreadditions are safe.- Docs restructure: new
getting-started,corporate-actionsandmaintenance/*guides, a shorter README, and a CHANGELOG that points to GitHub Releases. The anchors I spot-checked (#user-action-required,#cycle-result,#limitations,#4-add-currencies) exist. - Tests:
test_compose_example.pyis parametrized over both Compose files.test_documentation.pycovers the new guides. - OpenSpec: the change is archived and the specs are synced. No runtime or helper code changed, so nothing needs downstream DEGIRO propagation.
ℹ️ Default Compose file changes from two accounts to one
The deployment migration is documented in the README, CHANGELOG and docs/getting-started.md#existing-two-service-installations. Carry that warning into the release notes if a release is published, as the PR description already states.
Technical details
# Two-account to one-account default
## Affected sites
- compose.yaml — no longer defines `ibkr-sync-joint`; an auto-updating Git stack would orphan that service.
## Required outcome
- Release notes repeat the migration warning if a release is published.claude-sonnet-5-5 | 𝕏
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
Reviewed the delta since the prior Pullfrog review (a4afffb → f82d290). It is one docs-only commit that shortens operator prose. No runtime, Compose, .env.example or test files changed.
- README prose shortened: the intro, Quick start, Docker image, Safety first, Limitations and corporate-action summaries use shorter sentences. The
DRY_RUN,TZ, state and rollback guarantees are unchanged. - Getting-started guide restructured: the two-service migration is now a numbered list (pause Portainer auto-update, keep project name,
.envand state paths, selectcompose.multi-account.yaml, verify both services). It keeps the "do not remove orphans without review" warning. - Corporate-actions and activity-review guides condensed: retention (30 days,
.references.yaml,.rotation), native-split prerequisites (Ghostfolio 3.91.0+), state-loss and rollback steps keep their original meaning. - Configuration, troubleshooting and IBKR setup guides tightened: the dividend and payment-key rules are split into shorter paragraphs without changing the conditions.
- Doc-content checks still hold: I replicated the
test_documentation.pylink, anchor and README-retention assertions offline and they pass for every listed document. The README still contains the Python 3.14 strings thattest_dockerfile.pyexpects and has no3.12. The only image reference is:latest, astest_compose_example.pyrequires.
claude-sonnet-5-5 | 𝕏

Behavior
One account by default. One setup guide. Separate guides for configuration, blocked trades and maintenance.
Docker examples now persist state. Compose forwards private notification settings. Flex fields use one checklist. Old links still work.
Release impact
Existing two-account installs must switch to
compose.multi-account.yamlbefore updating.Keep the project name, ENV and state paths. Set
COMPOSE_FILEfor CLI use. Pause automatic Git stack updates first. Check Portainer file-selection support. Follow the migration steps.No runtime change or image release. Rollback restores the previous checkout and configuration. It does not undo financial writes. Repeat the migration warning in future release notes.
Verification
AI assistance
Codex implemented the change. External Claude reviewed the plan and implementation. Confirmed findings were fixed. This revision shortens the prose and splits long sentences.
Pullfrog review
Pullfrog review: no new issues at
f82d290.CI: all technical checks pass.
Manual operator review and merge. Auto-merge stays disabled.