Refactors documentation structure and adds AGENTS.md context index#53
Conversation
- Added AGENTS.md as a context index for contributors and AI agents - Replaced references to deleted architecture and dependency_injection documentation with a new context directory for focused topic docs
|
Warning Review limit reached
More reviews will be available in 33 minutes and 28 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds ChangesRepository documentation refresh
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/context/architecture.md`:
- Around line 6-11: The fenced diagram blocks in the architecture docs are
missing a language tag, which triggers markdownlint. Update the relevant fenced
code blocks around the architecture diagram so they use the text language tag,
and apply the same change to the other diagram block referenced in the review;
keep the diagram content unchanged while fixing the fences.
- Around line 3-18: The architecture diagram in the context doc reads in the
wrong direction relative to the inward-dependency rule. Update the diagram near
the Clean Architecture summary so the layer order/arrows in the `Presentation`,
`Domain`, `Data`, and `External` diagram match the textual rules below it,
making it visually clear that dependencies point inward.
In `@docs/context/codegen.md`:
- Around line 24-25: The generated-file list in the codegen workflow docs is
missing the `*.gen.dart` pattern. Update the generated-files section to include
`*.gen.dart` alongside the existing `*.g.dart`, `*.freezed.dart`, and
`*.mapper.dart` entries so the documentation matches the repository’s ignored
generated artifacts.
In `@docs/context/error-handling.md`:
- Around line 33-37: Make the UI-layer projection explicit in the switch that
handles result conversion so it is clear that `Error(:final error)` is being
mapped from a domain failure to a user-facing string, not changing the `Result`
contract. Update the example around the `switch (result)` expression to name
that this is a UI-facing conversion, and keep the mapping logic in the same
`Success`/`Error` handling path so readers can locate the intent immediately.
In `@docs/context/project-structure.md`:
- Around line 3-39: Add a language tag to the fenced tree block in
project-structure.md so markdownlint no longer flags it; update the existing
code fence around the directory tree to use a text fence, keeping the content
unchanged. Locate the fenced block in the project structure doc and adjust only
the fence syntax.
In `@docs/context/state-management.md`:
- Around line 53-55: The snackbar in the AsyncError handling path is displaying
`error.toString()` instead of the user-facing failure text. Update the `case
AsyncError(:final error)` branch to render the `Failure.message` when the error
is a `Failure`, and preserve a sensible fallback for non-Failure errors. Use the
existing `AsyncError` and `Failure` handling in this block to keep the UI
aligned with the error-handling contract.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5b311764-819e-49b8-b335-b4b8e101b7f7
📒 Files selected for processing (22)
AGENTS.mdCLAUDE.mdCURSOR.mdGEMINI.mdPUKU.mdREADME.mddocs/architecture.mddocs/context/adding-a-feature.mddocs/context/architecture.mddocs/context/codegen.mddocs/context/dependency-injection.mddocs/context/dos-and-donts.mddocs/context/error-handling.mddocs/context/gotchas.mddocs/context/localization.mddocs/context/naming-conventions.mddocs/context/networking.mddocs/context/project-structure.mddocs/context/routing.mddocs/context/state-management.mddocs/context/theming.mddocs/dependency_injection.md
💤 Files with no reviewable changes (2)
- docs/dependency_injection.md
- docs/architecture.md
1 participant
Summary
Replaces monolithic documentation with a modular
docs/context/layout and introducesAGENTS.mdas the single entry point for contributors and AI coding agents.Related Issue
(none)
Changes
AGENTS.md— a context index mapping 14 focused topics (architecture, state management, DI, routing, theming, error handling, networking, localization, and more) with repo-specific non-negotiablesdocs/context/— 14 single-concern docs aligned with the actual codebase conventions (Riverpod, GoRouter,Result/Failure, theme extensions, etc.)CLAUDE.md,CURSOR.md,GEMINI.md, andPUKU.mdthat redirect toAGENTS.mdREADME.md— project tree and documentation links now point toAGENTS.mdanddocs/context/instead of removed filesdocs/architecture.mddocs/dependency_injection.mdNew context docs (
docs/context/)architecture.mdproject-structure.mdcodegen.mdstate-management.mddependency-injection.mdrouting.mdtheming.mdcontext.*theme extensionserror-handling.mdResult/FailureviaasyncGuardnetworking.mdlocalization.mdnaming-conventions.mdadding-a-feature.mddos-and-donts.mdgotchas.mdTesting
AGENTS.mdand verify all topic links resolve correctlyREADME.mddocumentation section links toAGENTS.mdanddocs/context/docs/architecture.md,docs/dependency_injection.md) are no longer referenced anywhere in the repoSummary by CodeRabbit