docs: add initial agent documentation

[pratapalakshmi]

Summary by CodeRabbit

• Documentation
  • Established developer documentation framework defining structure, layout, and reference paths for guides covering API reference, setup, deployment, and troubleshooting.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
developer-docs	Ready	Preview, Comment	Apr 16, 2026 9:37am

[coderabbitai]

Warning

Rate limit exceeded

@pratapalakshmi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 47 minutes and 40 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 47 minutes and 40 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2a3d6bc8-e5a2-4666-b623-dc86e2b27822

📥 Commits

Reviewing files that changed from the base of the PR and between bb51641 and c75617e.

📒 Files selected for processing (1)

• AGENTS.md

📝 Walkthrough

Walkthrough

A new AGENTS.md file is introduced to provide internal developer documentation context for "Plane EE." The file outlines the purpose of a developer docs agent, specifies a hierarchical documentation structure, enumerates key documentation paths, and includes operational notes about documentation availability and configuration locations.

Changes

Cohort / File(s)	Summary
Documentation Agent Context AGENTS.md	New internal developer documentation file defining agent purpose, documentation layout hierarchy, key documentation paths (API reference, developer tools, MCP setup, app/build guides, self-hosting), and operational notes with correction for AI configuration path.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A map for the docs, so clear and so bright,
Guiding developers through features with might,
Hierarchies laid out, from API to deployment,
Now every agent knows what path is employment! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: introducing a new AGENTS.md documentation file for agent-related developer documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/add/docs/agents

---

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 7-25: The fenced code block in AGENTS.md (the opening line that
currently starts with ```) lacks a language specifier and triggers MD040; update
that opening fence to include a language identifier (for example change the
opening ``` to ```text) so the code block is explicitly marked (modify the
triple-backtick fence at the start of the shown block).
- Line 1: The CI failure is due to Prettier formatting violations in AGENTS.md;
run the Prettier formatter on that file (e.g., execute prettier --write
AGENTS.md) to correct formatting issues, then stage and commit the updated
AGENTS.md so CI picks up the fixed formatting.

🪄 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: 2e5bb6b7-d72f-4f02-9f1b-ed8ea1d34044

📥 Commits

Reviewing files that changed from the base of the PR and between 8d3ef3f and bb51641.

📒 Files selected for processing (1)

• AGENTS.md

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

Fix Prettier formatting issues to resolve CI failure.

The CI pipeline is failing due to Prettier formatting violations. Run prettier --write AGENTS.md to automatically fix the formatting issues.

#!/bin/bash
# Description: Run Prettier to fix formatting issues

prettier --write AGENTS.md

🧰 Tools

🪛 GitHub Actions: CI

[warning] 1-1: Prettier --check reported formatting issues in this file. Run 'prettier --write AGENTS.md' to fix.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 1, The CI failure is due to Prettier formatting violations
in AGENTS.md; run the Prettier formatter on that file (e.g., execute prettier
--write AGENTS.md) to correct formatting issues, then stage and commit the
updated AGENTS.md so CI picks up the fixed formatting.