Where to Find makeplane/plane Documentation: Official Guides and Source Links

The makeplane/plane repository lists all canonical documentation links in its top-level README.md, pointing to three primary resources: the public product docs at docs.plane.so, the developer portal at developers.plane.so, and self-hosting guides within the deployments/ directory.

The open-source project management platform Plane maintains comprehensive documentation across multiple endpoints. Whether you are deploying the SaaS product, integrating with the API, or self-hosting the application, the official makeplane/plane documentation provides structured guidance for every use case. All entry points are cataloged in the repository's README.md under the Documentation heading (lines 26-29).

Official Documentation Endpoints

The Plane project maintains three distinct documentation sites, all referenced in the repository's README.md under the Documentation section.

Product Documentation

The user-facing guide for the Plane SaaS product lives at https://docs.plane.so/. This resource covers end-user workflows, project management features, and UI navigation. As implemented in makeplane/plane, this link serves as the primary entry point for non-technical users.

Developer Documentation

API references, integration guides, and architecture details are available at https://developers.plane.so/. This site serves engineers building on top of the Plane platform and contains the technical specifications required for custom integrations.

Self-Hosting Documentation

For deployment-specific instructions, visit https://developers.plane.so/self-hosting/overview. This guide complements the raw deployment configurations stored in the repository, providing step-by-step instructions for Docker, Kubernetes, and other infrastructure setups.

In-Repository Documentation Sources

Beyond the external websites, the makeplane/plane repository contains canonical documentation files that serve as the source of truth for deployment and contribution guidelines.

README.md as the Central Hub

The top-level README.md acts as the primary entry point, linking to all external documentation resources. According to the source code analysis, this file contains the definitive mapping between the repository and its published guides at lines 26-29.

Deployment Guides in the deployments/ Directory

For self-hosting practitioners, the repository stores practical documentation alongside infrastructure code:

• deployments/cli/community/README.md – Contains Docker Compose deployment instructions
• deployments/kubernetes/community/README.md – Holds Kubernetes deployment manifests and configuration guides

These files function as living documentation, ensuring the deployment instructions remain synchronized with the actual infrastructure code.

Internal Documentation Standards

The docs/ directory houses project-specific guidelines, including docs/linting.md, which demonstrates the repository's internal documentation formatting standards for contributors.

How to Access Documentation Programmatically

You can extract documentation URLs directly from the repository's README.md using automated scripts. The following examples demonstrate how to retrieve the canonical documentation links programmatically.

Using Node.js with axios:

// Fetch 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/' ]

Using curl for quick verification:

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

Summary

• The makeplane/plane documentation is distributed across three official endpoints: docs.plane.so (product), developers.plane.so (API), and developers.plane.so/self-hosting (deployment)
• All canonical links are cataloged in the repository's README.md at lines 26-29
• Deployment-specific guides exist as README.md files within deployments/cli/community/ and deployments/kubernetes/community/
• The docs/ directory contains internal standards like linting.md for contributors

Frequently Asked Questions

Where is the makeplane/plane documentation hosted?

The primary documentation is hosted on two external domains: docs.plane.so for end-user product guides and developers.plane.so for API references and integration details. These URLs are hardcoded in the repository's README.md file under the Documentation heading.

Does the repository include self-hosting instructions?

Yes. While the overview lives at developers.plane.so/self-hosting/overview, the detailed deployment configurations and instructions are stored in the deployments/ directory, specifically within deployments/cli/community/README.md for Docker Compose and deployments/kubernetes/community/README.md for Kubernetes orchestration.

How can I contribute to the makeplane/plane documentation?

Contributions follow the patterns established in docs/linting.md and the repository's main README.md. Since the public documentation sites are generated from the project's source, updating the markdown files in the docs/ directory or the README.md will reflect in future documentation builds.

Is there a way to verify documentation URLs are still valid programmatically?

Yes. You can automate validation by fetching the raw README.md from the preview branch and parsing the documentation links using regex patterns, as demonstrated in the Node.js example that extracts URLs matching the docs.plane.so domain pattern.

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