Improving AGENTS.md

[jabrena]

Rationale for this change

Add better support for models

What changes are included in this PR?

• AGENTS.md

Are these changes tested?

Sip

Are there any user-facing changes?

No

Summary by CodeRabbit

• Documentation
  • Major overhaul of architecture and workflow docs, adding module overviews, transformation pipeline, site generation, templates, development guidelines, and build commands.
  • Centralized images for getting started and usage guides; updated links and corrected external reference to the quality framework.
  • Refreshed main docs with clarified links and a new summary explaining how the framework functions as a specialized, safety‑aware consultant for Java development.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates only. AGENTS.md was rewritten into a detailed, module-oriented architecture and workflow guide. README.md links and text were updated, including image paths and an external doc URL. Two documentation files updated image paths to a centralized images directory. No source code or public API changes.

Changes

Cohort / File(s)	Summary of edits
Architecture Doc Overhaul AGENTS.md	Rewrote document into module-oriented architecture overview, adding modules list, transformation pipeline, site generation, templates, development guidelines, build commands, and governance content.
README updates README.md	Updated image paths, adjusted internal doc links, switched one relative doc link to absolute URL, and added a paragraph under constraints/safety.
Docs image path normalization documentation/GETTING-STARTED.md, documentation/HOW-TO-USE.md	Updated multiple image references to use ./images/... instead of ./documentation/.... No content changes otherwise.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    actor Dev as Developer
    participant SPG as System Prompts Generator
    participant TP as Transformation Pipeline
    participant SG as Site Generator
    participant Pub as Public Docs

    Note over Dev,SPG: Edit docs, modules, and templates
    Dev->>SPG: Define/maintain prompts & rules
    SPG->>TP: Provide structured sources (e.g., XML)
    rect rgba(200,220,255,0.3)
    Note right of TP: XML → Markdown transformation
    TP->>TP: Normalize, enrich, organize content
    end
    TP->>SG: Hand off generated Markdown
    rect rgba(220,255,220,0.3)
    SG->>Pub: Build static site & artifacts
    end
    Pub-->>Dev: Published docs for review

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Initial round for AGENTS.md #290 — Prior changes to AGENTS.md; this PR further overhauls and expands that document.
• Minor improvement #274 — README documentation edits and link adjustments overlap with this PR’s README changes.
• Improvements in documentation #258 — Updates to README and HOW-TO-USE.md align with this PR’s documentation and image path revisions.

Poem

I thump my paw on parchment plain,
Paths aligned, the images remain.
A warren of modules, neat and bright—
Pipelines burrow into light.
With nibbling notes and tidy prose,
This doc-garden blooms where knowledge grows. 🐇📚

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/agents.md-v2

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7d47f8 and 3585a79.

⛔ Files ignored due to path filters (10)

• documentation/images/cursor-chat1.png is excluded by !**/*.png
• documentation/images/cursor-chat2.png is excluded by !**/*.png
• documentation/images/cursor-cli1.png is excluded by !**/*.png
• documentation/images/cursor-cli2.png is excluded by !**/*.png
• documentation/images/cursor-cli3.png is excluded by !**/*.png
• documentation/images/cursor-interaction-sequence.png is excluded by !**/*.png
• documentation/images/getting-started-github.png is excluded by !**/*.png
• documentation/images/getting-started-prompt.png is excluded by !**/*.png
• documentation/images/prompts.png is excluded by !**/*.png
• documentation/images/workflow.png is excluded by !**/*.png

📒 Files selected for processing (4)

• AGENTS.md (2 hunks)
• README.md (2 hunks)
• documentation/GETTING-STARTED.md (2 hunks)
• documentation/HOW-TO-USE.md (2 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}