Skip to content

refactor: reorganize Plane AI documentation into structured sub-pages #273

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

Draft
akhil-vamshi-konam wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

refactor: reorganize Plane AI documentation into structured sub-pages #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f60137
refactor: reorganize Plane AI documentation into structured sub-pages
akhil-vamshi-konam May 11, 2026
23671a1
fix: formatting of markdown tables for better readability
akhil-vamshi-konam May 11, 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
8 changes: 6 additions & 2 deletions docs/.vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,9 +309,13 @@ export default withMermaid(
{ text: "OpenSearch for search", link: "/self-hosting/govern/advanced-search" },
{
text: "Plane AI",
link: "/self-hosting/govern/plane-ai",
collapsed: true,
items: [{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" }],
items: [
{ text: "Get started", link: "/self-hosting/govern/plane-ai/getting-started" },
{ text: "Custom LLM models", link: "/self-hosting/govern/plane-ai/custom-llm" },
{ text: "Semantic search", link: "/self-hosting/govern/plane-ai/semantic-search" },
{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" },
],
},
{ text: "External secrets", link: "/self-hosting/govern/external-secrets" },
{ text: "External reverse proxy", link: "/self-hosting/govern/reverse-proxy" },
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/govern/aws-opensearch-embedding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,4 +232,4 @@ EMBEDDING_MODEL=cohere/embed-v4.0
OPENSEARCH_EMBEDDING_DIMENSION=1536
```

Restart Plane and complete the remaining steps in [Enable Plane AI](/self-hosting/govern/plane-ai#configure-an-embedding-model).
Restart Plane and complete the remaining steps in [Set up semantic search](/self-hosting/govern/plane-ai/semantic-search).
64 changes: 32 additions & 32 deletions docs/self-hosting/govern/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ These settings are required for semantic search and Plane AI Chat. Configure one
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret access key for Bedrock Titan embedding | Conditional |
| **BR_AWS_REGION** | AWS region for Bedrock Titan embedding | Conditional |

For setup instructions, supported models, and IAM permissions, see [Enable Plane AI](/self-hosting/govern/plane-ai).
For setup instructions, supported models, and IAM permissions, see [Plane AI](/self-hosting/govern/plane-ai/getting-started).

### API settings

Expand Down Expand Up @@ -293,37 +293,37 @@ For setup instructions, supported models, and IAM permissions, see [Enable Plane

### Plane Intelligence (PI) settings

| Variable | Description | Default Value |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| **OPENAI_API_KEY** | API key for OpenAI services used by Plane Intelligence. | |
| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible API endpoints. | |
| **CLAUDE_API_KEY** | API key for Anthropic Claude services used by Plane Intelligence. | |
| **CLAUDE_BASE_URL** | Custom base URL for Claude API endpoints. | |
| **GROQ_API_KEY** | API key for Groq services used by Plane Intelligence. | |
| **GROQ_BASE_URL** | Custom base URL for Groq API endpoints. | |
| **COHERE_API_KEY** | API key for Cohere services used by Plane Intelligence. | |
| **COHERE_BASE_URL** | Custom base URL for Cohere API endpoints. | |
| **CUSTOM_LLM_ENABLED** | Enable a custom OpenAI-compatible LLM provider. Set to `true` to enable. | false |
| **CUSTOM_LLM_MODEL_KEY** | Model key identifier for the custom LLM. | gpt-oss-120b |
| **CUSTOM_LLM_BASE_URL** | Base URL for the custom LLM API endpoint. | |
| **CUSTOM_LLM_API_KEY** | API key for the custom LLM provider. | |
| **CUSTOM_LLM_NAME** | Display name for the custom LLM in the Plane UI. | GPT-OSS-120B |
| **CUSTOM_LLM_DESCRIPTION** | Description of the custom LLM shown in the Plane UI. | A self-hosted OpenAI-compatible model |
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom LLM. | 128000 |
| **EMBEDDING_MODEL** | Model key for generating embeddings (e.g. `cohere/embed-v4.0`). Required for PI API startup when Plane AI is enabled. | |
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID for the deployed embedding model. | |
| **OPENSEARCH_EMBEDDING_DIMENSION** | Vector dimension for `knn_vector` fields; must match the embedding model and stay aligned with the API service. See [Plane AI](/self-hosting/govern/plane-ai). | 1536 |
| **BR_AWS_ACCESS_KEY_ID** | AWS access key for Amazon Bedrock integration. | |
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret key for Amazon Bedrock integration. | |
| **BR_AWS_SESSION_TOKEN** | AWS session token for Amazon Bedrock integration (for temporary credentials). | |
| **FASTAPI_APP_WORKERS** | Number of FastAPI workers for the PI service. | 1 |
| **PLANE_OAUTH_STATE_EXPIRY_SECONDS** | Expiry time (in seconds) for PI OAuth state tokens. | 82800 |
| **CELERY_VECTOR_SYNC_ENABLED** | Enable periodic vector synchronization for AI-powered search. | 0 |
| **CELERY_VECTOR_SYNC_INTERVAL** | Interval (in seconds) for vector synchronization. | 3 |
| **CELERY_WORKSPACE_PLAN_SYNC_ENABLED** | Enable periodic workspace plan synchronization. | 0 |
| **CELERY_WORKSPACE_PLAN_SYNC_INTERVAL** | Interval (in seconds) for workspace plan synchronization. | 86400 |
| **CELERY_DOCS_SYNC_ENABLED** | Enable periodic documents synchronization for AI indexing. | 0 |
| **CELERY_DOCS_SYNC_INTERVAL** | Interval (in seconds) for documents synchronization. | 86400 |
| Variable | Description | Default Value |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| **OPENAI_API_KEY** | API key for OpenAI services used by Plane Intelligence. | |
| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible API endpoints. | |
| **CLAUDE_API_KEY** | API key for Anthropic Claude services used by Plane Intelligence. | |
| **CLAUDE_BASE_URL** | Custom base URL for Claude API endpoints. | |
| **GROQ_API_KEY** | API key for Groq services used by Plane Intelligence. | |
| **GROQ_BASE_URL** | Custom base URL for Groq API endpoints. | |
| **COHERE_API_KEY** | API key for Cohere services used by Plane Intelligence. | |
| **COHERE_BASE_URL** | Custom base URL for Cohere API endpoints. | |
| **CUSTOM_LLM_ENABLED** | Enable a custom OpenAI-compatible LLM provider. Set to `true` to enable. | false |
| **CUSTOM_LLM_MODEL_KEY** | Model key identifier for the custom LLM. | gpt-oss-120b |
| **CUSTOM_LLM_BASE_URL** | Base URL for the custom LLM API endpoint. | |
| **CUSTOM_LLM_API_KEY** | API key for the custom LLM provider. | |
| **CUSTOM_LLM_NAME** | Display name for the custom LLM in the Plane UI. | GPT-OSS-120B |
| **CUSTOM_LLM_DESCRIPTION** | Description of the custom LLM shown in the Plane UI. | A self-hosted OpenAI-compatible model |
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom LLM. | 128000 |
| **EMBEDDING_MODEL** | Model key for generating embeddings (e.g. `cohere/embed-v4.0`). Required for PI API startup when Plane AI is enabled. | |
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID for the deployed embedding model. | |
| **OPENSEARCH_EMBEDDING_DIMENSION** | Vector dimension for `knn_vector` fields; must match the embedding model and stay aligned with the API service. See [Semantic search](/self-hosting/govern/plane-ai/semantic-search). | 1536 |
| **BR_AWS_ACCESS_KEY_ID** | AWS access key for Amazon Bedrock integration. | |
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret key for Amazon Bedrock integration. | |
| **BR_AWS_SESSION_TOKEN** | AWS session token for Amazon Bedrock integration (for temporary credentials). | |
| **FASTAPI_APP_WORKERS** | Number of FastAPI workers for the PI service. | 1 |
| **PLANE_OAUTH_STATE_EXPIRY_SECONDS** | Expiry time (in seconds) for PI OAuth state tokens. | 82800 |
| **CELERY_VECTOR_SYNC_ENABLED** | Enable periodic vector synchronization for AI-powered search. | 0 |
| **CELERY_VECTOR_SYNC_INTERVAL** | Interval (in seconds) for vector synchronization. | 3 |
| **CELERY_WORKSPACE_PLAN_SYNC_ENABLED** | Enable periodic workspace plan synchronization. | 0 |
| **CELERY_WORKSPACE_PLAN_SYNC_INTERVAL** | Interval (in seconds) for workspace plan synchronization. | 86400 |
| **CELERY_DOCS_SYNC_ENABLED** | Enable periodic documents synchronization for AI indexing. | 0 |
| **CELERY_DOCS_SYNC_INTERVAL** | Interval (in seconds) for documents synchronization. | 86400 |

::: details Community Edition

Expand Down
Loading
Loading