Skip to content

Commit 9f60137

Browse files
refactor: reorganize Plane AI documentation into structured sub-pages
1 parent 92279d1 commit 9f60137

7 files changed

Lines changed: 418 additions & 322 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,9 +309,13 @@ export default withMermaid(
309309
{ text: "OpenSearch for search", link: "/self-hosting/govern/advanced-search" },
310310
{
311311
text: "Plane AI",
312-
link: "/self-hosting/govern/plane-ai",
313312
collapsed: true,
314-
items: [{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" }],
313+
items: [
314+
{ text: "Get started", link: "/self-hosting/govern/plane-ai/getting-started" },
315+
{ text: "Custom LLM models", link: "/self-hosting/govern/plane-ai/custom-llm" },
316+
{ text: "Semantic search", link: "/self-hosting/govern/plane-ai/semantic-search" },
317+
{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" },
318+
],
315319
},
316320
{ text: "External secrets", link: "/self-hosting/govern/external-secrets" },
317321
{ text: "External reverse proxy", link: "/self-hosting/govern/reverse-proxy" },

docs/self-hosting/govern/aws-opensearch-embedding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,4 +232,4 @@ EMBEDDING_MODEL=cohere/embed-v4.0
232232
OPENSEARCH_EMBEDDING_DIMENSION=1536
233233
```
234234

235-
Restart Plane and complete the remaining steps in [Enable Plane AI](/self-hosting/govern/plane-ai#configure-an-embedding-model).
235+
Restart Plane and complete the remaining steps in [Set up semantic search](/self-hosting/govern/plane-ai/semantic-search).

docs/self-hosting/govern/environment-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ These settings are required for semantic search and Plane AI Chat. Configure one
237237
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret access key for Bedrock Titan embedding | Conditional |
238238
| **BR_AWS_REGION** | AWS region for Bedrock Titan embedding | Conditional |
239239

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

242242
### API settings
243243

@@ -312,7 +312,7 @@ For setup instructions, supported models, and IAM permissions, see [Enable Plane
312312
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom LLM. | 128000 |
313313
| **EMBEDDING_MODEL** | Model key for generating embeddings (e.g. `cohere/embed-v4.0`). Required for PI API startup when Plane AI is enabled. | |
314314
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID for the deployed embedding model. | |
315-
| **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 |
315+
| **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 |
316316
| **BR_AWS_ACCESS_KEY_ID** | AWS access key for Amazon Bedrock integration. | |
317317
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret key for Amazon Bedrock integration. | |
318318
| **BR_AWS_SESSION_TOKEN** | AWS session token for Amazon Bedrock integration (for temporary credentials). | |

docs/self-hosting/govern/plane-ai.md

Lines changed: 0 additions & 317 deletions
This file was deleted.

0 commit comments

Comments
 (0)