Skip to content

docs: add AGENTS.md, fix stale crate list in spec.md (#39 T2) - #43

Merged
rsenna merged 2 commits into
mainfrom
issue-39-t2-agents-md
Aug 2, 2026
Merged

rsenna merged 2 commits into
mainfrom
issue-39-t2-agents-md

Conversation

@owkwo-bot

@owkwo-bot owkwo-bot commented Aug 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

T2 of #39 (chore: adopt repo-standard, stage=in-progress): adds AGENTS.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 from docs/spec.md's Boundaries, dev commands, and a "where things live" map. Follows iklo's AGENTS.md pattern: 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 described guiltty-core as holding sprites -- both stale since guiltty-sprite was extracted out in #38. Fixed here rather than deferred, per the pull-request-process skill's doc-staleness guidance.

Note: 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 and this issue's explicit intent. Flagging in case the reviewer notices the file didn't show up via a plain git add ..

Test plan

  • Every "implemented" claim independently fact-checked against crates/*/src/lib.rs, examples/src/bin/demo.rs, Cargo.toml files, and .github/workflows/ci.yml
  • specs//.specify/ (other tasks of chore: adopt repo-standard (stage=in-progress) #39) correctly not claimed as present -- hedged as "may not exist yet"
  • Independently reviewed via pr-review-toolkit:review-pr

Part 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:

  • Introduce AGENTS.md as a concise operating guide for AI agents and new contributors, linking to specs, designs, intent, and tasks.
  • Document the actually implemented crates, rules of engagement, dev commands, and repository layout for the guiltty project.
  • Clarify in docs/spec.md that sprites are now provided by the separate guiltty-sprite crate rather than guiltty-core, and describe the new crate in the project structure section.

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. Updated docs/spec.md to add guiltty-sprite and clarify guiltty-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.

Review in cubic

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>
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@greptile-apps greptile-apps 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.

owkwo-bot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@sourcery-ai

sourcery-ai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds 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

Change Details Files
Clarify project structure and crate responsibilities in docs/spec.md to match the current codebase.
  • Update guiltty-core description to remove sprites from its responsibilities.
  • Add guiltty-sprite entry describing its role as the extracted sprite/bitmap crate and reference the design document.
  • Ensure examples/ description matches its function as runnable demos.
docs/spec.md
Introduce AGENTS.md as an agent/human contributor operating guide tied to current implementation rather than aspirational docs.
  • Document what is actually implemented today across guiltty-core, guiltty-sprite, guiltty-kitty, guiltty, and examples.
  • Summarize decided project rules derived from docs/spec.md boundaries and process skills.
  • Provide canonical dev commands for build/test/lint/format/coverage and note CI enforcement and toolchain pinning.
  • Add a "where things live" map of key files/directories and note potential presence of specs/ and .specify/ from repo-standard adoption.
  • Clarify that AGENTS.md is deliberately tracked despite global gitignore rules.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@rsenna, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 53 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: aa0dab35-65bd-4778-9454-6b0c8de68e60

📥 Commits

Reviewing files that changed from the base of the PR and between 8cc5e85 and 46ce467.

📒 Files selected for processing (2)
  • AGENTS.md
  • docs/spec.md

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

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@sourcery-ai sourcery-ai 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.

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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codacy-production codacy-production 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.

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

Comment thread docs/spec.md Outdated
Comment thread AGENTS.md Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/spec.md Outdated
- 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>
@owkwo-bot

Copy link
Copy Markdown
Collaborator Author

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.

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.

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.

Not a real inconsistency -- guiltty-examples is the crate name (used in cargo run -p guiltty-examples --bin <example-name>), and examples/src/bin/demo.rs is the file path to one specific binary within that crate. Both are correct simultaneously, same as referring to a library by crate name in one sentence and by file path in another. Leaving as-is.

@rsenna
rsenna merged commit 6b971a8 into main Aug 2, 2026
4 checks passed
@rsenna
rsenna deleted the issue-39-t2-agents-md branch August 2, 2026 18:04
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.

2 participants