Skip to content

Commit bb51641

Browse files
docs: add initial agent documentation
1 parent 8d3ef3f commit bb51641

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

AGENTS.md

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

0 commit comments

Comments
 (0)