Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
node_modules
dist
build
.vitepress
.vite_opt_cache
.vitepress/cache
.vitepress/temp
.vitepress/dist
.vitepress/build
.vitepress/preview
.vitepress/dev
.vitepress/preview
pnpm-lock.yaml
package-lock.json
yarn.lock
bun.lockb
bun.lock
bun.lock.json
bun.lock.yaml
bun.lock.json
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"printWidth": 120,
"singleQuote": true
}
28 changes: 17 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,20 @@ Thank you for your interest in contributing to Plane's developer documentation.
### Local Setup

1. Fork and clone the repository:

```bash
git clone https://github.com/makeplane/developer-docs.git
cd developer-docs
```

2. Install dependencies:

```bash
pnpm install
```

3. Start the development server:

```bash
pnpm dev
```
Expand All @@ -33,20 +36,20 @@ Thank you for your interest in contributing to Plane's developer documentation.

### Content Directories

| Directory | Purpose |
|-----------|---------|
| `docs/api-reference/` | REST API endpoint documentation |
| `docs/self-hosting/` | Deployment and configuration guides |
| `docs/dev-tools/` | Developer tools, webhooks, and extensions |
| `docs/plane-one/` | Plane One (licensed edition) documentation |
| Directory | Purpose |
| --------------------- | ------------------------------------------ |
| `docs/api-reference/` | REST API endpoint documentation |
| `docs/self-hosting/` | Deployment and configuration guides |
| `docs/dev-tools/` | Developer tools, webhooks, and extensions |
| `docs/plane-one/` | Plane One (licensed edition) documentation |

### Configuration Files

| File | Purpose |
|------|---------|
| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings |
| `docs/.vitepress/theme/style.css` | Global CSS styles |
| `docs/.vitepress/theme/components/` | Custom Vue components |
| File | Purpose |
| ----------------------------------- | -------------------------------------- |
| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings |
| `docs/.vitepress/theme/style.css` | Global CSS styles |
| `docs/.vitepress/theme/components/` | Custom Vue components |

## Writing Documentation

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

Use descriptive branch names:

- `docs/add-webhook-guide`
- `fix/typo-in-api-reference`
- `update/kubernetes-deployment`

### Commit Messages

Write clear, concise commit messages:

- `Add webhook payload examples`
- `Fix broken link in self-hosting guide`
- `Update Docker Compose instructions for v1.0`
Expand Down Expand Up @@ -141,6 +146,7 @@ response = requests.get(
### API Documentation

When documenting API endpoints:

- Include the HTTP method and path
- List all parameters with types and descriptions
- Show request and response examples
Expand Down
Loading