Skip to content

Commit f550b82

Browse files
feat: added prettier config and formatted all files (#333)
1 parent c89df8a commit f550b82

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+3665
-2662
lines changed

.github/workflows/docs-to-vector.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ jobs:
2424
}')
2525
2626
echo "$payload" > /tmp/payload.json
27-
27+
2828
- name: Connect to company network
2929
uses: tailscale/github-action@v3
3030
with:
3131
oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
3232
oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
3333
tags: tag:ci
34-
34+
3535
- name: Call Webhook (Preview)
3636
run: |
3737
payload=$(cat /tmp/payload.json)
3838
sig=$(printf '%s' "$payload" | \
3939
openssl dgst -sha256 -hmac "${{ secrets.VECTOR_WEBHOOK_SECRET_PREVIEW }}" -binary | xxd -p -c 256)
40-
40+
4141
curl -X POST \
4242
-H "Content-Type: application/json" \
4343
-H "X-Hub-Signature-256: sha256=$sig" \
@@ -50,11 +50,11 @@ jobs:
5050
payload=$(cat /tmp/payload.json)
5151
sig=$(printf '%s' "$payload" | \
5252
openssl dgst -sha256 -hmac "${{ secrets.VECTOR_WEBHOOK_SECRET }}" -binary | xxd -p -c 256)
53-
53+
5454
if [ "${{ secrets.VECTOR_WEBHOOK_URL }}" != "none" ]; then
5555
curl -X POST \
5656
-H "Content-Type: application/json" \
5757
-H "X-Hub-Signature-256: sha256=$sig" \
5858
-d "$payload" \
5959
${{ secrets.VECTOR_WEBHOOK_URL }}
60-
fi
60+
fi

.prettierrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"printWidth": 120,
3+
"tabWidth": 2,
4+
"trailingComma": "es5"
5+
}

CONTRIBUTING.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Plane documentation
22

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.
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.
44

55
## Report issues
66

@@ -10,43 +10,50 @@ If you encounter any issues with our documentation or have suggestions for impro
1010
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.
1111

1212
## Set up your development environment
13+
1314
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.
1415

1516
## How to submit changes
17+
1618
We follow a simple and structured process for submitting changes.
1719

1820
1. Checkout the `preview` branch:
19-
```bash
20-
git checkout preview
21-
```
21+
22+
```bash
23+
git checkout preview
24+
```
2225

2326
2. Pull the latest changes:
24-
```bash
25-
git pull origin preview
26-
```
27+
28+
```bash
29+
git pull origin preview
30+
```
2731

2832
3. Create a new branch:
29-
```bash
30-
git checkout -b <branch-name>
31-
```
33+
34+
```bash
35+
git checkout -b <branch-name>
36+
```
3237

3338
4. Make necessary changes in the code editor of your choice.
3439

3540
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+
```
4046

4147
6. Push the changes.
42-
```bash
43-
git push origin <branch-name>
44-
```
48+
49+
```bash
50+
git push origin <branch-name>
51+
```
4552

4653
7. Raise a pull request (PR) to merge your branch into the **preview** branch. Please provide a detailed description of your changes.
4754

4855
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.
4956

5057
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!
5158

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).

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
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).
44

55
## Overview
6+
67
The Plane documentation provides detailed information on the following topics:
78

89
- Understanding the different components of Plane.
@@ -11,32 +12,36 @@ The Plane documentation provides detailed information on the following topics:
1112
## Installation
1213

1314
1. Clone the repository.
14-
```bash
15-
git clone [email protected]:makeplane/docs.git
16-
```
15+
16+
```bash
17+
git clone [email protected]:makeplane/docs.git
18+
```
1719

1820
2. Navigate to the project directory.
19-
```bash
20-
cd docs
21-
```
21+
22+
```bash
23+
cd docs
24+
```
2225

2326
3. Install dependencies.
24-
```bash
25-
yarn
26-
```
27+
```bash
28+
yarn
29+
```
2730

2831
## Local development
2932

3033
```bash
3134
yarn start
3235
```
36+
3337
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
3438

3539
## Build
3640

3741
```bash
3842
yarn build
3943
```
44+
4045
This command generates static files into the `build` directory.
4146

4247
## Contributing

babel.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module.exports = {
2-
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
2+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
33
};

docs/core-concepts/account/overview.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,5 @@ Stickies allow you to create, organize, and personalize notes or reminders direc
3131
- Keep all your notes in one easily accessible and visible place, ensuring nothing gets overlooked.
3232

3333
## See also
34-
- [Stickies](/core-concepts/stickies)
34+
35+
- [Stickies](/core-concepts/stickies)

docs/core-concepts/account/settings.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Your account settings offer the ability to adjust your profile details, password
1010
Access your account settings from the side-navigation bar by clicking on your name/profile picture and selecting **Settings**.
1111

1212
![Profile dropdown](https://media.docs.plane.so/account/account-profile-dropdown.webp#center)
13+
1314
## Profile
1415

1516
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:
3334
- Sidebar text color: Specifies the color of text displayed on the side navigation bar.
3435

3536
### First day of the week
37+
3638
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.
3739

3840
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.
3941

4042
### Smooth cursor
43+
4144
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.
4245

4346
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
5760
- Comments added to work items
5861
- Work items created and assigned to you
5962

60-
![Email](https://media.docs.plane.so/account/account-email-preferences.webp#center)
63+
![Email](https://media.docs.plane.so/account/account-email-preferences.webp#center)

0 commit comments

Comments
 (0)