Repository navigation
docs: keep operator guidance direct and actionable - #327
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
No prior Pullfrog review existed, so this covers the full PR at 289a261 (the incremental diff was unavailable).
- ASD-STE-100 docs rule — the
AGENTS.mdDocs:bullet now makes the writing style permanent and keeps the existing "spec-required docs only" limit. - CodeQL runs on every PR —
.github/workflows/codeql.ymldrops thescopejob and theneeds/ifgate onanalyze, so docs-only PRs publish the CodeQL result that the branch rules require. Actions stay SHA-pinned, permissions stay minimal, and.github/BUILD.mdanddocs/release-notes-automation.mdalready describe this behavior. No test or doc references the removed job.
claude-sonnet-5-5 | 𝕏
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
Covers the new commit df19488 since the prior Pullfrog review at 289a261. It changes docs only, so no runtime, spec or workflow behavior is affected.
- Activity review decision table —
docs/activity-review.mdadds a "Choose the next action" table that links to existing sections. - Configuration reference rewrite —
docs/configuration.mdadds a contents list and replaces the numbered setup headings with unnumbered ones.<a id>anchors keep the old numbered links working. Long sentences are split with the same meaning, and the#create-accountslink is updated. - Operator actions first —
docs/corporate-actions.mdadds a "Resolve a blocked trade" section ahead of the evidence reference.docs/ibkr-setup.mdmoves the three historical Flex procedures todocs/upgrading-to-3.0.mdwith the text intact and leaves link stubs at the old anchors. I checked that the new cross-links resolve to existing headings.
claude-sonnet-5-5 | 𝕏

Behavior
Make ASD-STE-100 permanent for repository documentation.
Use English, short sentences, active voice and direct instructions. Remove repetition.
Keep commands, prerequisites, safety limits and recovery steps complete.
AGENTS.mdowns the rule.CLAUDE.mdimports it.Editorial finish from the follow-up review:
README, runtime and inter-account migration contracts stay unchanged.
CodeQL now runs for documentation PRs too. Branch rules require an analysis result. A skipped job left this PR blocked.
Release impact
No runtime change or image release. CodeQL runs on every PR.
Rollback: revert this commit.
Verification
Diff and whitespace checks pass. Shared and project guidance were checked for contradictions, including the shared work-tracker guidance.
48 existing documentation, Compose and Docker guidance checks pass. Workflow YAML parses. Historical procedures were moved intact. Original anchors remain reachable. CI must publish a CodeQL result.
AI assistance
Codex wrote the rule after operator confirmation.
Pullfrog review
Pullfrog: no new issues at
df19488.CI: all checks pass.
GitHub reports
CLEANandMERGEABLE.Manual operator merge. Auto-merge disabled.