docs: add AGENTS.md, fix stale crate list in spec.md (#39 T2) - #43
Conversation
T2 of issue #39: AGENTS.md is an in-progress-tier agent operating guide per the repo-standard convention -- what's actually implemented today, decided rules (from docs/spec.md's Boundaries), dev commands, and a "where things live" map, linking out to the real sources rather than duplicating them (iklo's AGENTS.md pattern). Writing it surfaced a stale doc: docs/spec.md's Project Structure section still listed only 3 crates and described guiltty-core as holding sprites, both true before guiltty-sprite was extracted out (PR #38). Fixed in the same commit rather than deferred, per the pull-request-process skill's doc-staleness guidance. AGENTS.md is blanket-ignored by this machine's global gitignore (alongside .claude/, .junie/, CLAUDE.local.md) -- force-added deliberately, matching iklo's own tracked AGENTS.md precedent and this issue's explicit intent. Co-Authored-By: WOZCODE <contact@withwoz.com>
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
There was a problem hiding this comment.
owkwo-bot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.
Reviewer's GuideAdds an AGENTS.md operational guide describing what is currently implemented, rules, dev commands, and project layout, and updates docs/spec.md’s project structure section to reflect the split-out guiltty-sprite crate and correct core’s responsibilities. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Review limit reached
Next review available in: 53 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?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 reviews. How do review 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 refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Comment |
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- AGENTS.md repeats the workspace layout and crate descriptions already captured in docs/spec.md; consider centralizing this “where things live” section in one place and having the other file link to it to reduce the chance of future drift.
- The example/run commands use the
guiltty-examplescrate name while the implementation section referencesexamples/src/bin/demo.rs; it may be clearer to consistently describe the examples as a crate (and mention its path) to avoid confusion for new contributors.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- AGENTS.md repeats the workspace layout and crate descriptions already captured in docs/spec.md; consider centralizing this “where things live” section in one place and having the other file link to it to reduce the chance of future drift.
- The example/run commands use the `guiltty-examples` crate name while the implementation section references `examples/src/bin/demo.rs`; it may be clearer to consistently describe the examples as a crate (and mention its path) to avoid confusion for new contributors.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull Request Overview
The PR introduces the AGENTS.md guide and updates the project specification in docs/spec.md. Codacy analysis indicates the changes are up to standards.
The review identified two consistency issues that should be addressed before merging: a contradiction in docs/spec.md claiming zoom/scroll logic is implemented, and a missing 'text' component in the directory map within AGENTS.md. Addressing these will ensure the documentation provides a reliable and accurate source of truth for both human and AI contributors.
Test suggestions
- Verify that all documentation links in AGENTS.md point to existing files in the repository.
- Verify the 'What is actually implemented today' section accurately matches the current workspace members.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
There was a problem hiding this comment.
All reported issues were addressed across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
- docs/spec.md's guiltty-core Project Structure line still listed "regions, zoom/scroll logic" as if implemented, contradicting AGENTS.md's own "Not started" section for that work. Reworded to match guiltty-core/src/lib.rs's own module doc comment. - AGENTS.md's "Where things live" summary for guiltty-core was missing "text", even though draw_text is listed as implemented earlier in the same file. Independently re-verified via pr-review-toolkit:review-pr before pushing, including a broader sweep for other AGENTS.md/spec.md contradictions -- none found. Co-Authored-By: WOZCODE <contact@withwoz.com>
Deliberate, not accidental duplication: AGENTS.md's map is a terse "where things live" pointer (one line per crate), while docs/spec.md's Project Structure section is more detailed prose -- similar content, different altitude, matching iklo's own AGENTS.md/spec split (which this repo's is modeled on). That said, the drift risk you're flagging is real -- this very PR round hit it twice (the "regions, zoom/scroll logic" and missing-"text" fixes just pushed). Leaving the two files as-is rather than restructuring in this PR, but noting it as a real maintenance cost worth watching.
Not a real inconsistency -- |
Summary
T2 of #39 (
chore: adopt repo-standard, stage=in-progress): addsAGENTS.md, an in-progress-tier agent operating guide per the repo-standard design doc -- what's actually implemented today (fact-checked against source, not aspirational), decided rules fromdocs/spec.md's Boundaries, dev commands, and a "where things live" map. Follows iklo'sAGENTS.mdpattern: a short hub page linking to real sources rather than duplicating them.Also fixes
docs/spec.md's Project Structure section, which still listed only 3 crates and describedguiltty-coreas holding sprites -- both stale sinceguiltty-spritewas extracted out in #38. Fixed here rather than deferred, per the pull-request-process skill's doc-staleness guidance.Note:
AGENTS.mdis blanket-ignored by this machine's global gitignore (alongside.claude/,.junie/,CLAUDE.local.md) -- force-added deliberately, matching iklo's own trackedAGENTS.mdand this issue's explicit intent. Flagging in case the reviewer notices the file didn't show up via a plaingit add ..Test plan
crates/*/src/lib.rs,examples/src/bin/demo.rs,Cargo.tomlfiles, and.github/workflows/ci.ymlspecs//.specify/(other tasks of chore: adopt repo-standard (stage=in-progress) #39) correctly not claimed as present -- hedged as "may not exist yet"pr-review-toolkit:review-prPart of #39.
🧙 Built with WOZCODE
Summary by Sourcery
Add an agent operating guide documenting current project state and workflows, and update the spec’s project structure to reflect the extracted sprite crate and clarified core responsibilities.
Documentation:
Summary by cubic
Added
AGENTS.md, a concise operating guide that documents what’s implemented today, the rules, dev commands, and where things live, with links to source docs. Updateddocs/spec.mdto addguiltty-spriteand clarifyguiltty-core(no regions/zoom/scroll), and fixed remaining stale wording in both files; part of #39 repo-standard adoption.Written for commit 46ce467. Summary will update on new commits.