Skip to content

Commit

Permalink
fix: Readme docs updated (makeplane#35)
Browse files Browse the repository at this point in the history
* Fix-Readme

- Improved clarity and readability.
- Added more detailed information about the project.
- Enhanced formatting and structure.

* fix: updated gitignore

---------

Co-authored-by: Nikhila Jain <[email protected]>
  • Loading branch information
sriramveeraghanta and jnikhila authored Dec 1, 2023
1 parent c9403c4 commit 11fd3a0
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ yarn-error.log*
.env
# vercel
.vercel

# lock files
package-lock.json
66 changes: 62 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,64 @@
# Plane Docs
<h1 style="text-align:center; font-size: 3.5em;">Plane</h1>

This repository contains the documentation for [Plane](https://github.com/makeplane/plane),
the Open Source alternative for JIRA, Linear and Height.
<figure>
<img src="https://raw.githubusercontent.com/makeplane/docs/master/public/logos/logo.svg" alt="The Plane Logo" style=" display:block; margin-left: auto; margin-right: auto; width: 25%;">
<figcaption style="text-align:center; font-size:3em;">Project management tool from the future.</figcaption>
</figure>

The documentation is hosted at [docs.plane.so](https://docs.plane.so)
----
This repository hosts all the documentation for Plane, and it is available at [docs.plane.so](https://docs.plane.so). If you are looking for the Plane code, please see the [Plane repo](https://github.com/makeplane/plane).

----

## Table of Contents

1. [About Plane](#about-plane)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Contributing](#contributing)
5. [Community and Support](#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:

```bash
npm install @markdoc/markdoc
```

2. Install dependencies with:

```bash
npm install
```

3. Start the local development with:

```bash
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](https://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](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md) for detailed instructions on contributing code, reporting issues, and more.
* Please follow our [Code of Conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) to ensure a respectful and inclusive community.
## Community and Support
For any issues or support, please contact the plane team via [Discord](https://discord.com/invite/A92xrEGCge).

0 comments on commit 11fd3a0

Please sign in to comment.