Skip to content

docs: keep operator guidance direct and actionable - #327

Merged
flowcool merged 3 commits into
mainfrom
docs/permanent-writing-style
Oct 28, 2026
Merged

flowcool merged 3 commits into
mainfrom
docs/permanent-writing-style

Conversation

@flowcool

@flowcool flowcool commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

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.md owns the rule. CLAUDE.md imports it.

Editorial finish from the follow-up review:

  • Move historical Flex procedures to the existing upgrade guide. Keep old links.
  • Put blocked-trade actions before evidence-retention details.
  • Add an activity-review decision table.
  • Remove broken setup numbering. Add a configuration contents list and shorten complex sentences.

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 CLEAN and MERGEABLE.

Manual operator merge. Auto-merge disabled.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords: 2
  • docs:
  • docs(

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 28, 2026

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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.md Docs: bullet now makes the writing style permanent and keeps the existing "spec-required docs only" limit.
  • CodeQL runs on every PR — .github/workflows/codeql.yml drops the scope job and the needs/if gate on analyze, so docs-only PRs publish the CodeQL result that the branch rules require. Actions stay SHA-pinned, permissions stay minimal, and .github/BUILD.md and docs/release-notes-automation.md already describe this behavior. No test or doc references the removed job.

Pullfrog  | Fix it ➔ | View workflow run | Using claude-sonnet-5-5 | 𝕏

@flowcool flowcool changed the title docs: make ASD-STE-100 the documentation default docs: keep operator guidance direct and actionable Oct 28, 2026

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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.md adds a "Choose the next action" table that links to existing sections.
  • Configuration reference rewrite — docs/configuration.md adds 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-accounts link is updated.
  • Operator actions first — docs/corporate-actions.md adds a "Resolve a blocked trade" section ahead of the evidence reference. docs/ibkr-setup.md moves the three historical Flex procedures to docs/upgrading-to-3.0.md with the text intact and leaves link stubs at the old anchors. I checked that the new cross-links resolve to existing headings.

Pullfrog  | Fix it ➔ | View workflow run | Using claude-sonnet-5-5 | 𝕏

@flowcool
flowcool merged commit a02eac7 into main Oct 28, 2026
16 checks passed
@flowcool
flowcool deleted the docs/permanent-writing-style branch October 28, 2026 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant