Skip to content

Fix documentation drift in architecture doc and AGENTS.md - #189

Merged
bartul merged 2 commits into
masterfrom
docs/fix-architecture-agents-drift
Oct 11, 2026
Merged

bartul merged 2 commits into
masterfrom
docs/fix-architecture-agents-drift

Conversation

@bartul

@bartul bartul commented Oct 11, 2026

Copy link
Copy Markdown
Owner

Summary

Resolves the documentation-drift findings (F4) from the technical consistency audit in #176, plus a few additional stale spots found while verifying them.

docs/architecture.md

  • Describe the implemented Gameplay setup slice instead of "Not yet implemented".
  • Clarify that Rondel and Gameplay expose execute/handle, while Accounting exposes only execute.
  • Rename Move.execute to Movement.execute.
  • Correct the handler contract: internal handlers return effects and public routers commit them and return Async<unit>; Accounting's stateless skeleton is noted as the exception.

AGENTS.md

  • Versions: Terminal.Gui 2.4.17, Expecto 11.1.0.
  • File listings: Terminal app in the solution description, Gameplay Handlers.fs, Rondel DirectCommit.fs; mkAttr attributed to RondelView.fs.
  • Handler return contract aligned with the code (five places).
  • Command dispatch now describes RondelDirectCommit sequential dispatch instead of List.fold/Result.bind.
  • Gameplay facade added to the public API surface; hosts note that Gameplay has none yet.
  • Open Work records the Terminal/Gameplay wiring gap tracked in type = improvement: Wire Gameplay setup orchestration into Terminal app #142; test-helper description replaced with the current Context + SpecRunner.empty pattern.
  • RondelView colors match the code; Move.execute renamed in the section-order table.
  • Testing: Gameplay spec files added to test organization; DirectCommitTests.fs added to the coverage snapshot.
  • PR workflow: drop the "Merge commit" option since only squash merge is enabled.

Refs #176

Describe the implemented Gameplay setup slice, clarify which bounded
contexts expose execute/handle routers, rename Move.execute to
Movement.execute, and correct the handler return contract: internal
handlers return effects while public routers commit and return
Async<unit>, with Accounting's stateless skeleton as the exception.

Refs #176
Align versions (Terminal.Gui 2.4.17, Expecto 11.1.0), file listings
(Gameplay Handlers.fs, Rondel DirectCommit.fs), the handler return
contract, command dispatch description, RondelView colors, test context
pattern, and test coverage snapshot with the current code. Record the
Terminal/Gameplay wiring gap tracked in #142 and drop the disabled
merge-commit option.

Refs #176
@coderabbitai

coderabbitai Bot commented Oct 11, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c398453d-8b55-4f51-9b34-4cd069ac3685

  • 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.

@bartul
bartul merged commit 6dfc677 into master Oct 11, 2026
5 checks passed
@bartul
bartul deleted the docs/fix-architecture-agents-drift branch October 11, 2026 19:09
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.

1 participant