-
Notifications
You must be signed in to change notification settings - Fork 11
fix: formatting for all pages #216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6979f34
fix: formatting for all pages
sriramveeraghanta 6906566
fix: formatting
sriramveeraghanta 8559d57
fix: formatting
sriramveeraghanta 9e6214b
fix: formatting
sriramveeraghanta 1ba35cc
fix: formatting
sriramveeraghanta 6115ee8
fix: formatting
sriramveeraghanta 8b879f1
fix: replace preview branch with master
sriramveeraghanta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # CLAUDE.md | ||
|
|
||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||
|
|
||
| ## Project Overview | ||
|
|
||
| This is the **Plane developer documentation site** built with **VitePress** (Vue 3-based static site generator). It covers REST API reference, self-hosting guides, and developer tools documentation for the Plane project management platform. | ||
|
|
||
| Live site: https://developers.plane.so | ||
|
|
||
| ## Commands | ||
|
|
||
| ```bash | ||
| pnpm install # Install dependencies (use --frozen-lockfile in CI) | ||
| pnpm dev # Start dev server at http://localhost:5173 | ||
| pnpm build # Production build | ||
| pnpm preview # Preview production build | ||
| pnpm check:format # Check Prettier formatting | ||
| pnpm fix:format # Auto-fix Prettier formatting | ||
| ``` | ||
|
|
||
| **CI checks on PRs** (to `preview` and `master`): Prettier formatting + VitePress build must pass. | ||
|
|
||
| ## Architecture | ||
|
|
||
| - **`docs/`** — All documentation content and VitePress config | ||
| - **`docs/.vitepress/config.mts`** — Main VitePress config: navigation, sidebar structure, SEO, Algolia search, analytics. This is a large file (~39KB) that defines the entire site structure. | ||
| - **`docs/.vitepress/theme/`** — Custom theme with Vue components and global styles | ||
| - **`docs/api-reference/`** — REST API endpoint docs (180+ endpoints across 25+ categories) | ||
| - **`docs/self-hosting/`** — Deployment guides (Docker, Kubernetes, etc.) | ||
| - **`docs/dev-tools/`** — Webhooks, OAuth apps, agents, MCP server docs | ||
|
|
||
| ## Custom Vue Components | ||
|
|
||
| Used directly in markdown files — defined in `docs/.vitepress/theme/components/`: | ||
|
|
||
| | Component | Usage | | ||
| | ---------------------- | ----------------------------------------------------------------- | | ||
| | `<ApiParam>` | API parameter with name, type, required badge, expandable details | | ||
| | `<CodePanel>` | Multi-language code tabs (cURL, Python, JavaScript) | | ||
| | `<ResponsePanel>` | Syntax-highlighted API response JSON | | ||
| | `<Card>` | Feature card with icon, title, description | | ||
| | `<CardGroup cols="N">` | Responsive grid layout (2, 3, or 4 columns) | | ||
|
|
||
| ## API Documentation Pattern | ||
|
|
||
| API endpoint pages follow a strict two-column layout pattern: | ||
|
|
||
| ```markdown | ||
| <div class="api-two-column"> | ||
| <div class="api-left"> | ||
| <!-- Parameters using <ApiParam> --> | ||
| </div> | ||
| <div class="api-right"> | ||
| <!-- Code examples using <CodePanel> + <ResponsePanel> --> | ||
| </div> | ||
| </div> | ||
| ``` | ||
|
|
||
| Each endpoint page: one file per endpoint, includes path/body params, OAuth scopes, and code examples in cURL/Python/JavaScript. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - **Frontmatter**: Every markdown page needs `title`, `description`, and `keywords` fields | ||
| - **Images**: Stored in `docs/.vitepress/public/images/`, referenced with absolute paths (`/images/...`) | ||
| - **Branch workflow**: Branch from `preview` (main branch), use `fix/`, `feat/`, `docs/`, `update/` prefixes | ||
| - **Formatting**: Prettier enforced — 120 char width, 2-space indent, semicolons, double quotes, ES5 trailing commas | ||
| - **Sidebar updates**: When adding new pages, update the sidebar config in `docs/.vitepress/config.mts` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.