Where to Find Documentation for makeplane/plane: Official Links and Repository Guide

The makeplane/plane repository lists all official documentation links in the top-level README.md, including the product docs at docs.plane.so, developer docs at developers.plane.so, and self-hosting guides within the deployments/ directory.

Plane is an open-source project management platform that maintains its documentation for makeplane/plane across multiple official channels. The repository's README.md serves as the primary entry point, directing users to user-facing guides, API references, and deployment instructions. All canonical links are centralized in the documentation section of the readme file.

Official Documentation Portals

The project maintains three distinct documentation portals to serve different user needs. These URLs are hardcoded in the repository's README.md under the Documentation heading at lines 26-29.

Product Documentation

The user-facing guide for the Plane SaaS product lives at https://docs.plane.so/. This portal contains feature guides, tutorials, and workspace management instructions for end users.

Developer Documentation

API references, integration guides, and architecture details are hosted at https://developers.plane.so/. This resource targets developers building on top of Plane or contributing to the codebase.

Self-Hosting Documentation

Step-by-step deployment instructions for Docker, Kubernetes, and other self-hosting methods are available at https://developers.plane.so/self-hosting/overview. These guides complement the deployment scripts found in the repository.

Repository Documentation Structure

Beyond the external websites, the makeplane/plane repository contains embedded documentation that serves as both reference material and practical deployment instructions.

README.md as the Central Hub

The top-level README.md file acts as the canonical source for documentation links. According to the source code at /cache/repos/github.com/makeplane/plane/preview/README.md#L26-L29, the Documentation section lists all official external URLs. This file also references quick-start installation methods and distinguishes between Plane Cloud and self-hosted options.

Internal Documentation in the docs/ Directory

The repository maintains a docs/ folder containing internal development resources. The file /cache/repos/github.com/makeplane/plane/preview/docs/linting.md provides an example of how documentation is authored within the repository, demonstrating the project's standards for code quality and contribution guidelines.

Self-Hosting Guides in the Deployments Directory

Practical deployment documentation lives alongside the infrastructure code. The deployments/cli/community/README.md contains Docker-compose self-hosting instructions, while deployments/kubernetes/community/README.md holds the Kubernetes deployment guide. These files are referenced from the main developer documentation and provide copy-paste ready configurations for system administrators.

Accessing Documentation Programmatically

You can extract documentation URLs directly from the repository's README.md using standard HTTP clients. The repository already depends on axios, making it a natural choice for Node.js implementations.

The following TypeScript example fetches the README and extracts documentation links using regular expressions:

// Example: fetch the README and extract documentation links
import axios from "axios";

async function getDocLinks() {
  const readmeUrl =
    "https://raw.githubusercontent.com/makeplane/plane/preview/README.md";
  const { data } = await axios.get(readmeUrl);
  const docLinks = data.match(
    /(https?:\/\/[^\s]+docs\.plane\.so[^\s]*)/g
  );
  return docLinks;
}

getDocLinks().then(console.log);
// → [ 'https://docs.plane.so/', 'https://developers.plane.so/' ]

For quick verification from the command line, use curl to inspect the main documentation page:

curl -s https://docs.plane.so/ | head -n 20

Summary

• The documentation for makeplane/plane is centralized in the repository's README.md at lines 26-29, which links to three official portals: product docs, developer docs, and self-hosting guides.
• External documentation is hosted at docs.plane.so for users and developers.plane.so for technical integration and API references.
• Self-hosting instructions are maintained both on the developer portal and as practical deployment scripts in deployments/cli/community/README.md and deployments/kubernetes/community/README.md.
• Internal documentation standards are demonstrated in docs/linting.md, showing how the project maintains code quality guidelines.
• Documentation URLs can be programmatically extracted from the raw README using standard HTTP requests and regex patterns.

Frequently Asked Questions

Where is the main documentation for makeplane/plane hosted?

The primary documentation is hosted on two official websites: https://docs.plane.so/ for end-user product guides and https://developers.plane.so/ for API and integration documentation. These links are listed in the repository's README.md file under the Documentation section at lines 26-29.

How do I find self-hosting instructions for Plane?

Self-hosting documentation is available at https://developers.plane.so/self-hosting/overview and within the repository's deployments/ directory. The deployments/cli/community/README.md provides Docker-compose instructions, while deployments/kubernetes/community/README.md contains Kubernetes deployment configurations.

Is there API documentation available in the repository?

While the API documentation itself is hosted externally at https://developers.plane.so/, the repository references these resources in the README.md. The developer portal contains comprehensive API references and integration guides rather than static markdown files in the repository.

What internal documentation exists in the docs/ folder?

The docs/ directory contains internal development documentation, specifically docs/linting.md which outlines code quality standards and linting rules for contributors. This folder serves as a reference for development practices rather than end-user product documentation.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}