/docs

The official https://docs.plane.so documentation 📝

Primary LanguageJavaScript

Plane

The Plane Logo

Project management tool from the future.

This repository hosts all the documentation for Plane, and it is available at docs.plane.so. If you are looking for the Plane code, please see the Plane repo.


Table of Contents

  1. About Plane
  2. Installation
  3. Usage
  4. Contributing
  5. Community and Support

About Plane

Plane is a user-friendly, extensible, and open-source project and product management tool. It serves as a versatile platform, allowing users to start their project management process with a simple task-tracking tool and smoothly progress towards implementing diverse project management methodologies, including Agile, Waterfall, and numerous others, to suit their growing needs.

Installation

Setting up Plane's documentation on your local machine is straightforward. Follow these installation steps:

  1. Install the Markdoc library with:

    npm install @markdoc/markdoc
  2. Install dependencies with:

    npm install
  3. Start the local development with:

    npm run dev

This command launches a local development server, and you can access the documentation at http://localhost:3000.

Usage

Refer to our comprehensive documentation at docs.plane.so for detailed instructions on using Plane, including setup, configuration, and practical examples.

Contributing

We welcome contributions from the community to improve Plane. Here's how you can get involved:

  • Review our Contribution Guidelines for detailed instructions on contributing code, reporting issues, and more.

  • Please follow our Code of Conduct to ensure a respectful and inclusive community.

Community and Support

For any issues or support, please contact the plane team via Discord.