Skip to content

docs: add initial agent documentation #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pratapalakshmi merged 2 commits into from
Apr 16, 2026
Merged

docs: add initial agent documentation #260

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb51641
docs: add initial agent documentation
pratapalakshmi Apr 16, 2026
c75617e
docs: format AGENTS.md for improved readability
pratapalakshmi Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Developer Docs Agent Context
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 16, 2026

Choose a reason for hiding this comment

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

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


## Purpose

Internal developer documentation for Plane EE.

## Structure

```text
docs/
api-reference/ # REST API docs — 30+ resource categories (issues, cycles, modules, pages, etc.)
dev-tools/ # Developer tooling guides
agents/ # Agent development (overview, building, signals, best practices)
build-plane-app/ # App development guide
mcp-server.md # MCP server setup
mcp-server-claude-code.md # MCP server with Claude Code
plane-compose.md # Plane Compose reference
openapi-specification.md
intro-webhooks.md
self-hosting/ # Deployment and configuration guides
methods/ # Docker, Kubernetes, Podman, Coolify, Portainer, one-click, airgapped
install-methods-commercial/ # Commercial Docker Compose and Kubernetes
govern/ # Auth, integrations, settings, SSL, DNS, env vars
integrations/ # GitHub, GitLab, Slack, Sentry
manage/ # Backup/restore, Prime CLI, update Plane, logs, user management
troubleshoot/ # CLI errors, installation, license, storage errors
```

## Key Documentation Paths

- `self-hosting/methods/kubernetes.md` - K8s deployment guide
- `self-hosting/methods/install-methods-commercial/` - Commercial Docker Compose and Kubernetes
- `self-hosting/govern/integrations/` - GitHub, GitLab, Slack, Sentry
- `self-hosting/govern/plane-ai.md` - AI features configuration
- `self-hosting/govern/environment-variables.md` - All env var reference
- `self-hosting/govern/authentication.md` - Auth setup (LDAP, OIDC, SAML, OAuth)
- `self-hosting/govern/reverse-proxy.md` - Reverse proxy setup
- `self-hosting/manage/` - Instance management, backup/restore, Prime CLI
- `dev-tools/agents/` - Agent development docs
- `dev-tools/mcp-server.md` and `mcp-server-claude-code.md` - MCP server docs

## Important Notes

- Not all features are documented immediately after release
- Check both public docs (docs.plane.so) and internal docs
- `self-hosting/govern/plane-ai.md` is the correct path for AI config (not `self-hosting/plane-ai.md`)
- API reference covers 30+ resource categories — check `docs/api-reference/` for the full list
Loading