|
| 1 | +# Developer Docs Agent Context |
| 2 | + |
| 3 | +## Purpose |
| 4 | + |
| 5 | +Internal developer documentation for Plane EE. |
| 6 | + |
| 7 | +## Structure |
| 8 | + |
| 9 | +```text |
| 10 | +docs/ |
| 11 | + api-reference/ # REST API docs — 30+ resource categories (issues, cycles, modules, pages, etc.) |
| 12 | + dev-tools/ # Developer tooling guides |
| 13 | + agents/ # Agent development (overview, building, signals, best practices) |
| 14 | + build-plane-app/ # App development guide |
| 15 | + mcp-server.md # MCP server setup |
| 16 | + mcp-server-claude-code.md # MCP server with Claude Code |
| 17 | + plane-compose.md # Plane Compose reference |
| 18 | + openapi-specification.md |
| 19 | + intro-webhooks.md |
| 20 | + self-hosting/ # Deployment and configuration guides |
| 21 | + methods/ # Docker, Kubernetes, Podman, Coolify, Portainer, one-click, airgapped |
| 22 | + install-methods-commercial/ # Commercial Docker Compose and Kubernetes |
| 23 | + govern/ # Auth, integrations, settings, SSL, DNS, env vars |
| 24 | + integrations/ # GitHub, GitLab, Slack, Sentry |
| 25 | + manage/ # Backup/restore, Prime CLI, update Plane, logs, user management |
| 26 | + troubleshoot/ # CLI errors, installation, license, storage errors |
| 27 | +``` |
| 28 | + |
| 29 | +## Key Documentation Paths |
| 30 | + |
| 31 | +- `self-hosting/methods/kubernetes.md` - K8s deployment guide |
| 32 | +- `self-hosting/methods/install-methods-commercial/` - Commercial Docker Compose and Kubernetes |
| 33 | +- `self-hosting/govern/integrations/` - GitHub, GitLab, Slack, Sentry |
| 34 | +- `self-hosting/govern/plane-ai.md` - AI features configuration |
| 35 | +- `self-hosting/govern/environment-variables.md` - All env var reference |
| 36 | +- `self-hosting/govern/authentication.md` - Auth setup (LDAP, OIDC, SAML, OAuth) |
| 37 | +- `self-hosting/govern/reverse-proxy.md` - Reverse proxy setup |
| 38 | +- `self-hosting/manage/` - Instance management, backup/restore, Prime CLI |
| 39 | +- `dev-tools/agents/` - Agent development docs |
| 40 | +- `dev-tools/mcp-server.md` and `mcp-server-claude-code.md` - MCP server docs |
| 41 | + |
| 42 | +## Important Notes |
| 43 | + |
| 44 | +- Not all features are documented immediately after release |
| 45 | +- Check both public docs (docs.plane.so) and internal docs |
| 46 | +- `self-hosting/govern/plane-ai.md` is the correct path for AI config (not `self-hosting/plane-ai.md`) |
| 47 | +- API reference covers 30+ resource categories — check `docs/api-reference/` for the full list |
0 commit comments