Skip to content
Merged
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
2 changes: 2 additions & 0 deletions .github/workflows/check-format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,6 @@ jobs:

- run: pnpm install --frozen-lockfile

- run: pnpm check:types

- run: pnpm build
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ Thank you for your interest in contributing to Plane's developer 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/styles.css` | Global CSS styles (VoidZero/Vitest theme) |
| `docs/.vitepress/theme/plane-overrides.css` | Plane-specific CSS overrides |
| `docs/.vitepress/theme/components/` | Custom Vue components |

## Writing Documentation

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ docs/
│ ├── config.mts # VitePress configuration
│ ├── theme/ # Custom Vue theme
│ │ ├── components/ # Custom Vue components
│ │ └── style.css # Global styles
│ │ ├── styles.css # VoidZero/Vitest theme styles
│ │ └── plane-overrides.css # Plane-specific overrides
│ └── public/ # Static assets (images, logos)
├── api-reference/ # REST API documentation
├── self-hosting/ # Deployment and configuration guides
Expand Down
Loading
Loading