Skip to content

Commit bdf8de4

Browse files
fix: formatting for api reference markdown (#215)
1 parent 1d2c5ab commit bdf8de4

File tree

119 files changed

+1694
-1892
lines changed

Some content is hidden

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

119 files changed

+1694
-1892
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,20 @@ Thank you for your interest in contributing to Plane's developer documentation.
1212
### Local Setup
1313

1414
1. Fork and clone the repository:
15+
1516
```bash
1617
git clone https://github.com/makeplane/developer-docs.git
1718
cd developer-docs
1819
```
1920

2021
2. Install dependencies:
22+
2123
```bash
2224
pnpm install
2325
```
2426

2527
3. Start the development server:
28+
2629
```bash
2730
pnpm dev
2831
```
@@ -33,20 +36,20 @@ Thank you for your interest in contributing to Plane's developer documentation.
3336

3437
### Content Directories
3538

36-
| Directory | Purpose |
37-
|-----------|---------|
38-
| `docs/api-reference/` | REST API endpoint documentation |
39-
| `docs/self-hosting/` | Deployment and configuration guides |
40-
| `docs/dev-tools/` | Developer tools, webhooks, and extensions |
41-
| `docs/plane-one/` | Plane One (licensed edition) documentation |
39+
| Directory | Purpose |
40+
| --------------------- | ------------------------------------------ |
41+
| `docs/api-reference/` | REST API endpoint documentation |
42+
| `docs/self-hosting/` | Deployment and configuration guides |
43+
| `docs/dev-tools/` | Developer tools, webhooks, and extensions |
44+
| `docs/plane-one/` | Plane One (licensed edition) documentation |
4245

4346
### Configuration Files
4447

45-
| File | Purpose |
46-
|------|---------|
47-
| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings |
48-
| `docs/.vitepress/theme/style.css` | Global CSS styles |
49-
| `docs/.vitepress/theme/components/` | Custom Vue components |
48+
| File | Purpose |
49+
| ----------------------------------- | -------------------------------------- |
50+
| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings |
51+
| `docs/.vitepress/theme/style.css` | Global CSS styles |
52+
| `docs/.vitepress/theme/components/` | Custom Vue components |
5053

5154
## Writing Documentation
5255

@@ -88,13 +91,15 @@ Place images in `docs/.vitepress/public/images/` and reference them with absolut
8891
### Branch Naming
8992

9093
Use descriptive branch names:
94+
9195
- `docs/add-webhook-guide`
9296
- `fix/typo-in-api-reference`
9397
- `update/kubernetes-deployment`
9498

9599
### Commit Messages
96100

97101
Write clear, concise commit messages:
102+
98103
- `Add webhook payload examples`
99104
- `Fix broken link in self-hosting guide`
100105
- `Update Docker Compose instructions for v1.0`
@@ -141,6 +146,7 @@ response = requests.get(
141146
### API Documentation
142147

143148
When documenting API endpoints:
149+
144150
- Include the HTTP method and path
145151
- List all parameters with types and descriptions
146152
- Show request and response examples

0 commit comments

Comments
 (0)