You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to Plane documentation! We're thrilled to have you here, and we're eager to work together to make this project better.
3
+
Thank you for your interest in contributing to Plane documentation! We're thrilled to have you here, and we're eager to work together to make this project better.
4
4
5
5
## Report issues
6
6
@@ -10,43 +10,50 @@ If you encounter any issues with our documentation or have suggestions for impro
10
10
2.**Create an issue**: If you don't find an existing issue that matches your concern, feel free to create a new one. Provide as much detail as possible to clearly explain the problem or enhancement you're proposing.
11
11
12
12
## Set up your development environment
13
+
13
14
To get started with the development environment, please refer to our [README.md](/README.md). It contains all the necessary instructions to set up your environment and dependencies.
14
15
15
16
## How to submit changes
17
+
16
18
We follow a simple and structured process for submitting changes.
17
19
18
20
1. Checkout the `preview` branch:
19
-
```bash
20
-
git checkout preview
21
-
```
21
+
22
+
```bash
23
+
git checkout preview
24
+
```
22
25
23
26
2. Pull the latest changes:
24
-
```bash
25
-
git pull origin preview
26
-
```
27
+
28
+
```bash
29
+
git pull origin preview
30
+
```
27
31
28
32
3. Create a new branch:
29
-
```bash
30
-
git checkout -b <branch-name>
31
-
```
33
+
34
+
```bash
35
+
git checkout -b <branch-name>
36
+
```
32
37
33
38
4. Make necessary changes in the code editor of your choice.
34
39
35
40
5. Commit your changes. Leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made.
36
-
```bash
37
-
git add .
38
-
git commit -m "Fixes #<issue-number>: Description of the fix or enhancement"
39
-
```
41
+
42
+
```bash
43
+
git add .
44
+
git commit -m "Fixes #<issue-number>: Description of the fix or enhancement"
45
+
```
40
46
41
47
6. Push the changes.
42
-
```bash
43
-
git push origin <branch-name>
44
-
```
48
+
49
+
```bash
50
+
git push origin <branch-name>
51
+
```
45
52
46
53
7. Raise a pull request (PR) to merge your branch into the **preview** branch. Please provide a detailed description of your changes.
47
54
48
55
8. Before we can merge your contribution, you must sign the Contributor License Agreement (CLA). This agreement ensures that your contributions comply with our licensing terms.
49
56
50
57
After you submit your PR, a member of the Plane team will review it. Depending on our workload, response times may vary, but we'll do our best to get back to you as soon as possible. Thank you for your patience!
51
58
52
-
If you need any help or have any questions, join us on [Discord](https://discord.com/invite/A92xrEGCge).
59
+
If you need any help or have any questions, join us on [Discord](https://discord.com/invite/A92xrEGCge).
Copy file name to clipboardExpand all lines: README.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@
3
3
This website is built using [Docusaurus v3](https://docusaurus.io/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs).
4
4
5
5
## Overview
6
+
6
7
The Plane documentation provides detailed information on the following topics:
7
8
8
9
- Understanding the different components of Plane.
@@ -11,32 +12,36 @@ The Plane documentation provides detailed information on the following topics:
Your profile includes details about you, primarily your name and display name, which are visible to others, especially in the assignee or creator sections of work items and other entities. You can update this information here.
@@ -33,11 +34,13 @@ To create your custom theme, you can specify the following:
33
34
- Sidebar text color: Specifies the color of text displayed on the side navigation bar.
34
35
35
36
### First day of the week
37
+
36
38
Make your calendar feel just right by choosing which day kicks off your week. Whether you're team Sunday (traditional calendar style) or prefer Monday (workweek vibes), this setting ensures all calendars throughout the app match your personal preference.
37
39
38
40
Once you set this up in your preferences, every calendar view - from project timelines to due date pickers - will automatically align with your chosen week structure. It's one of those small touches that makes the whole experience feel more natural to how you think about time.
39
41
40
42
### Smooth cursor
43
+
41
44
If you love that buttery-smooth feel when moving your cursor around, toggle on the smooth cursor option. This feature adds a subtle animation to your cursor movement, creating a more fluid and responsive experience as you navigate through editors and interface elements.
42
45
43
46
Some people find it makes the app feel more polished and easier on the eyes, especially during longer editing sessions. Give it a try and see if the smoother motion feels right for your workflow - you can always toggle it off if you prefer the snappier default cursor behavior.
@@ -57,4 +60,4 @@ Notifications include updates on work items you've created, are assigned to, or
0 commit comments