Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.35 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.35 KB
Raw

Plane Documentation

This website is built using Docusaurus v3 and hosted at docs.plane.so. If you are looking for the developer documentation, see Plane developer documentation.

Overview

The Plane documentation provides detailed information on the following topics:

  • Understanding the different components of Plane.
  • Establishing connections between Plane and other applications.

Installation

  1. Clone the repository.

    git clone [email protected]:makeplane/docs.git

  2. Navigate to the project directory.

    cd docs

  3. Install dependencies.

    yarn

Local development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static files into the build directory.

Contributing

Interested in helping us improve the documentation? We’d love your contributions! Whether you're fixing a typo, adding a new guide, or improving an existing page, every bit helps.

To get started, check out our Contribution Guide. We welcome contributions related to core product features or integrations with other tools.