Add AGENTS.md and update CLAUDE.md with project documentation

[UdaraWickramarathne]

Documentation Setup

Adds standard AI agent documentation files to improve developer onboarding
and assist AI-assisted development workflows.

Changes

• AGENTS.md – Comprehensive project documentation including architecture
  overview, module layout, build/test commands, request flow, database setup,
  testing patterns, CI/CD pipeline, and PR conventions.
• CLAUDE.md – Updated to reference AGENTS.md as the primary
  documentation source for this repository.

Why

These files provide structured context for both human developers and AI coding
assistants, reducing onboarding time and ensuring consistent development practices.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2db9e9cd-0917-4c0a-a79f-652688fdd631

📥 Commits

Reviewing files that changed from the base of the PR and between b05649c and 8bab79b.

📒 Files selected for processing (2)

• AGENTS.md
• CLAUDE.md

---

📝 Walkthrough

Overview

Added comprehensive project documentation to assist developer onboarding and support AI-assisted workflows within the repository.

Changes

AGENTS.md (new file, +89 lines)

• Comprehensive project documentation covering architecture overview and repository structure
• Dual-perspective MkDocs site layout (developer vs platform-engineer views)
• Directory organization and shared resources (theme overrides, dictionary, CI/build references)
• MkDocs configuration including plugins and extensions in use
• Contributor workflow conventions and redirect-map requirements
• Build and development practices guidance

CLAUDE.md (updated, +4 lines)

• Updated to reference AGENTS.md as the primary documentation source for the repository
• Directs readers to AGENTS.md for full project overview and development guidelines

Impact

Establishes centralized documentation to streamline developer onboarding and provide clear context for both human developers and AI coding assistants, ensuring consistent development practices across the project.

Walkthrough

This pull request adds two new documentation files to establish project conventions and contributor guidance. AGENTS.md provides comprehensive documentation covering the project overview, dual-perspective architecture (developer vs platform-engineer perspectives), MkDocs build and serve commands, shared directory structure, plugin/extension configuration, and contributor workflow including redirect-map requirements and strictness guidelines. CLAUDE.md serves as a reference file that directs users to AGENTS.md for complete repository and development documentation.

Sequence Diagram

No sequence diagram required. These are documentation-only changes with no interactive components or sequential flows between system elements.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description covers the main changes, rationale, and benefits. However, it does not follow the required template structure with explicit sections for 'Type of change' and 'Testing' checkboxes.	Restructure the description to match the repository template: add 'Type of change' and 'Testing' sections with appropriate checkboxes, and explicitly list any related issues or mark as N/A.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely describes the main changes: adding AGENTS.md and updating CLAUDE.md with project documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}