Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 27 additions & 1 deletion apps/developer-docs/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,33 @@ export default extendConfig(
description:
"Plane is open-source, modern project management software. These developer docs cover self-hosting, the REST API, and tools for building on Plane.",
details:
"This documentation covers self-hosting (Docker, Kubernetes, and more), the REST API reference for projects, work items, cycles, modules, states, pages, and more, plus developer tools including OAuth apps, webhooks, agents, and the MCP server.",
"This documentation covers self-hosting (Docker, Kubernetes, and more), the REST API reference for projects, work items, cycles, modules, states, pages, and more, plus developer tools including OAuth apps, webhooks, agents, and the MCP server. Every page is also available as Markdown: append `.md` to its URL or request it with `Accept: text/markdown`.",
// llmstxt.org layout: H1, blockquote, details, then H2 link sections. "Related
// documentation" points agents at docs.plane.so (how to use the product) and
// "Optional" holds the bulk files they can skip.
customLLMsTxtTemplate:
"# {title}\n\n{description}\n\n{details}\n\n## Table of Contents\n\n{toc}\n\n## Related documentation\n\n{related}\n\n## Optional\n\n{optional}\n",
customTemplateVariables: {
related: [
"- [Plane product documentation](https://docs.plane.so/llms.txt): Index of docs.plane.so — how to use Plane: workspaces, projects, work items, cycles, modules, pages, integrations, importers, automations, and Plane AI.",
"- [Core concepts](https://docs.plane.so/introduction/core-concepts.md): The building blocks the API exposes — workspaces, projects, work items, cycles, modules, views, and pages.",
"- [Quickstart](https://docs.plane.so/introduction/quickstart.md): Set up a workspace and a first project.",
"- [Roles and permissions](https://docs.plane.so/roles-and-permissions/overview.md): What each workspace and project role is allowed to do.",
].join("\n"),
optional: [
"- [Complete documentation in one file](https://developers.plane.so/llms-full.txt): Every page of developers.plane.so concatenated as Markdown (about 1.6 MB).",
"- [Sitemap](https://developers.plane.so/sitemap.xml): Every page URL on developers.plane.so.",
"- [Plane on GitHub](https://github.com/makeplane/plane): Source code, issues, and releases.",
"- [plane.so](https://plane.so): Product website, pricing, and sign-up.",
].join("\n"),
},
// The "/" sidebar only holds shortcut groups that repeat pages from the section
// sidebars, so drop it to keep every page listed exactly once.
sidebar: (configSidebar) => {
if (!configSidebar || Array.isArray(configSidebar)) return configSidebar;
const { "/": _shortcuts, ...sections } = configSidebar;
return sections;
},
// Per-page .md versions are already emitted by buildEnd() for the
// `Accept: text/markdown` rewrite in vercel.json, so the plugin only
// owns llms.txt / llms-full.txt.
Expand Down
22 changes: 21 additions & 1 deletion apps/docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,27 @@ const config = defineConfig({
description:
"Plane is open-source, modern project management software for planning, tracking, and shipping work.",
details:
"This documentation covers workspaces, projects, work items, cycles, modules, pages and wikis, integrations, importers, automations, and Plane AI.",
"This documentation covers workspaces, projects, work items, cycles, modules, pages and wikis, integrations, importers, automations, and Plane AI. Every page is also available as Markdown: append `.md` to its URL or request it with `Accept: text/markdown`.",
// llmstxt.org layout: H1, blockquote, details, then H2 link sections. "Related
// documentation" points agents at developers.plane.so (API, webhooks, MCP server,
// self-hosting) and "Optional" holds the bulk files they can skip.
customLLMsTxtTemplate:
"# {title}\n\n{description}\n\n{details}\n\n## Table of Contents\n\n{toc}\n\n## Related documentation\n\n{related}\n\n## Optional\n\n{optional}\n",
customTemplateVariables: {
related: [
"- [Plane developer documentation](https://developers.plane.so/llms.txt): Index of developers.plane.so — REST API reference, webhooks, OAuth apps, the MCP server, agents, and self-hosting guides.",
"- [REST API reference](https://developers.plane.so/api-reference/introduction.md): Authentication, pagination, rate limits, and every endpoint of the Plane public API.",
"- [Webhooks](https://developers.plane.so/dev-tools/intro-webhooks.md): Real-time event notifications for work items, cycles, modules, and more.",
"- [MCP server](https://developers.plane.so/dev-tools/mcp-server.md): Let AI assistants read and update Plane through the Model Context Protocol.",
"- [Self-host Plane](https://developers.plane.so/self-hosting/overview.md): Deploy Plane with Docker Compose, Kubernetes, or Podman.",
].join("\n"),
optional: [
"- [Complete documentation in one file](https://docs.plane.so/llms-full.txt): Every page of docs.plane.so concatenated as Markdown (about 1 MB).",
"- [Sitemap](https://docs.plane.so/sitemap.xml): Every page URL on docs.plane.so.",
"- [Plane on GitHub](https://github.com/makeplane/plane): Source code, issues, and releases.",
"- [plane.so](https://plane.so): Product website, pricing, and sign-up.",
].join("\n"),
},
// Per-page .md versions are already emitted by buildEnd() for the
// `Accept: text/markdown` rewrite in vercel.json, so the plugin only
// owns llms.txt / llms-full.txt.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"headers": [
{
"key": "Link",
"value": "</api-reference/introduction>; rel=\"service-doc\"; type=\"text/html\", </sitemap.xml>; rel=\"sitemap\"; type=\"application/xml\""
"value": "</llms.txt>; rel=\"describedby\"; type=\"text/plain\", </api-reference/introduction>; rel=\"service-doc\"; type=\"text/html\", </sitemap.xml>; rel=\"sitemap\"; type=\"application/xml\""
},
{
"key": "X-Robots-Tag",
Expand Down
Loading