Developer Docs Migration to Docusarus #128

aheckmann · 2025-07-30T23:40:34Z

Description

Migrate to docusaurus
Migrate to Vercel
Update branding
Add SDKs, Apps and AI Solutions sections
Refactor webhooks guide and add more examples
Add welcome page
Various content improvements
Ensure all old urls redirect correctly

Type of Change

Bug fix (non-breaking change which fixes an issue)
Feature (non-breaking change which adds functionality)
Improvement (change that would cause existing functionality to not work as expected)
Code refactoring
Performance improvements
Documentation update

Screenshots and Media (if applicable)

Please visit the Vercel preview.

vercel · 2025-07-30T23:40:40Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
developer-docs	Ready	Preview	Comment	Sep 2, 2025 10:08am

coderabbitai · 2025-07-30T23:40:42Z

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

96 files out of 298 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch v2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Prashant-Surya · 2025-08-01T08:01:17Z

@aheckmann Our old developer docs used to offer a playground to interact with APIs directly from our website, I couldn't find similar behaviour in the new version. Do we still support this?

Prashant-Surya · 2025-08-01T08:02:43Z

docs/api/get-workspace-work-item.api.mdx

+>
+</Heading>
+
+<ParamsDetails


In the below page, "ExampleIssueIdentifier" looks like a button but there's no action associated with it. Can we change style for this?

Fixed. These are arrays of examples. Often our schema only includes a single item in the examples. Either way, it looks nicer now whether there are a single or multiple examples provided.

Prashant-Surya · 2025-08-01T08:03:57Z

docs/api/search-work-items.api.mdx

@@ -0,0 +1,71 @@
+---
+id: search-work-items
+title: "search_work_items"


Title doesn't seem to be readable as other APIs, should we update this?

API docs are auto-generated from our api spec. Let's fix in the spec.

aheckmann · 2025-08-01T14:36:02Z

Our old developer docs used to offer a playground to interact with APIs directly from our website, I couldn't find similar behaviour in the new version. Do we still support this?

Good catch - I'll re-enable it since it works from developers.plane.so. I had disabled it b/c in my testing, requests from browsers were failing (No 'Access-Control-Allow-Origin' header is present on the requested resource.)

@Prashant-Surya

These work on the developers.plane.so domain, but not if you run this site on other domains b/c the api currently blocks you.

this was moved into /apps

* chore: rm all * chore: migrate to docusaurus * fix(vercel): wildcard redirect * chore: import latest changes * fix: front-matter description spacing * fix: the 404s * chore: run prod locally * chore: search styling DX-15 * chore: better search styles * chore: write intro page DX-11 * chore: add old plane-one docs these were not live on the previous site so not making them live here just yet. * chore: format * chore: migrate dot files * feat: add sdks * chore(ci): use nvmrc * feat: ai-solutions DX-8 * chore: standardize on "overview" * chore: helm 1.3.1 * chore: refactor the webhooks guide DX-19 * chore: fix up titles and footer links * chore: clarify webhook verification * chore: pnpm version * chore(build): corepack enable * fix: img styles * chore: new primary colors * fix(style): fix a11y color contrast * fix: footer link icon * chore: serve locally * fix(react): use correct attr name * fix(style): navbar link color * fix: css issue in nav * chore: rm all * chore: migrate to docusaurus * fix(vercel): wildcard redirect * chore: import latest changes * fix: front-matter description spacing * fix: the 404s * chore: run prod locally * chore: search styling DX-15 * chore: better search styles * chore: write intro page DX-11 * chore: add old plane-one docs these were not live on the previous site so not making them live here just yet. * chore: format * chore: migrate dot files * feat: add sdks * chore(ci): use nvmrc * feat: ai-solutions DX-8 * chore: standardize on "overview" * chore: helm 1.3.1 * chore: refactor the webhooks guide DX-19 * chore: fix up titles and footer links * chore: clarify webhook verification * chore: pnpm version * chore(build): corepack enable * fix: img styles * chore: new primary colors * fix(style): fix a11y color contrast * fix: footer link icon * chore: serve locally * fix(react): use correct attr name * fix(style): navbar link color * fix: css issue in nav * Github Enterprise Server - Create GitHub App * chore: better api introduction * chore: re-enable interactive api examples These work on the developers.plane.so domain, but not if you run this site on other domains b/c the api currently blocks you. * chore: fix colors for api docs * chore(api): better lang highlighting * chore: improve openapi styles * feat: apps * chore: styles * chore: refactor github app page * chore: rm old file this was moved into /apps * Fixed navbar and fonts * Updated page order for self-hosting * Updated Dev tools section * minor edits * fixed broken link * removed duplicate schema.yaml * Restored original content on GitHub and Build Apps * fixed broken links * Updated content on deployment methods * Updated content in Configure category * Updated content in Manage and Troubleshoot categories * Updated content --------- Co-authored-by: Aaron Heckmann <[email protected]>

aheckmann requested review from sriramveeraghanta and danciaclara July 30, 2025 23:41

vercel bot deployed to Preview July 30, 2025 23:59 View deployment

vercel bot deployed to Preview July 31, 2025 00:08 View deployment

aheckmann force-pushed the v2 branch from ea463e4 to 3c842c0 Compare July 31, 2025 00:10

vercel bot deployed to Preview July 31, 2025 00:11 View deployment

vercel bot deployed to Preview July 31, 2025 00:19 View deployment

aheckmann requested a review from Prashant-Surya July 31, 2025 00:31

vercel bot deployed to Preview July 31, 2025 17:46 View deployment

vercel bot deployed to Preview July 31, 2025 17:50 View deployment

vercel bot deployed to Preview July 31, 2025 22:28 View deployment

Prashant-Surya reviewed Aug 1, 2025

View reviewed changes

vercel bot deployed to Preview August 1, 2025 14:22 View deployment

vercel bot deployed to Preview August 1, 2025 14:26 View deployment

aheckmann force-pushed the v2 branch from 0933c52 to faebd78 Compare August 1, 2025 15:35

vercel bot deployed to Preview August 1, 2025 15:36 View deployment

vercel bot deployed to Preview August 1, 2025 18:40 View deployment

aheckmann requested a review from Prashant-Surya August 1, 2025 18:46

vercel bot had a problem deploying to Preview August 1, 2025 19:06 Failure

aheckmann force-pushed the v2 branch from 42aa32b to ec11454 Compare August 1, 2025 19:09

vercel bot deployed to Preview August 1, 2025 19:10 View deployment

vercel bot deployed to Preview August 1, 2025 23:41 View deployment

vercel bot deployed to Preview August 2, 2025 00:15 View deployment

vercel bot deployed to Preview August 2, 2025 00:17 View deployment

vercel bot had a problem deploying to Preview August 12, 2025 17:56 Failure

chore: rm all

17b1b4d

aheckmann and others added 19 commits August 12, 2025 10:59

fix(style): fix a11y color contrast

72ac4a8

fix: footer link icon

e659b61

chore: serve locally

8de9c12

fix(react): use correct attr name

045a926

fix(style): navbar link color

4702245

fix: css issue in nav

81d1cfc

Github Enterprise Server - Create GitHub App

25ef0d4

chore: better api introduction

a59fef8

chore: re-enable interactive api examples

ab480b3

These work on the developers.plane.so domain, but not if you run this site on other domains b/c the api currently blocks you.

chore: fix colors for api docs

0a57e3a

chore(api): better lang highlighting

563b8f9

chore: improve openapi styles

61bfb26

feat: apps

4a59fb7

chore: styles

fd372c4

chore: refactor github app page

d456cb5

chore: rm old file

9c047d6

this was moved into /apps

chore: add copilot instructions

0941637

chore: refactor for punctuation, spelling and clarity

ae173a8

chore: port #135 changes

f160923

aheckmann force-pushed the v2 branch from 7762809 to f160923 Compare August 12, 2025 18:10

vercel bot had a problem deploying to Preview August 12, 2025 18:11 Failure

aheckmann added 2 commits August 13, 2025 08:50

fix: broken links

7951b25

feat: persisted language selection

faeeeb4

vercel bot deployed to Preview August 13, 2025 16:08 View deployment

vercel bot deployed to Production August 18, 2025 10:08 View deployment

fix: formating changes

bd15edb

vercel bot deployed to Production August 18, 2025 10:29 View deployment

sriramveeraghanta changed the title ~~Migration~~ Developer Docs Migration to Docusarus Sep 2, 2025

vercel bot deployed to Production September 2, 2025 10:08 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Developer Docs Migration to Docusarus #128

Developer Docs Migration to Docusarus #128

Uh oh!

aheckmann commented Jul 30, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 30, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

Prashant-Surya commented Aug 1, 2025

Uh oh!

Prashant-Surya Aug 1, 2025

Uh oh!

aheckmann Aug 1, 2025

Uh oh!

Prashant-Surya Aug 1, 2025

Uh oh!

aheckmann Aug 1, 2025

Uh oh!

aheckmann commented Aug 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Developer Docs Migration to Docusarus #128

Are you sure you want to change the base?

Developer Docs Migration to Docusarus #128

Uh oh!

Conversation

aheckmann commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Screenshots and Media (if applicable)

Uh oh!

vercel bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

Prashant-Surya commented Aug 1, 2025

Uh oh!

Prashant-Surya Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

aheckmann Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Prashant-Surya Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

aheckmann Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

aheckmann commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

aheckmann commented Jul 30, 2025 •

edited

Loading

vercel bot commented Jul 30, 2025 •

edited

Loading

coderabbitai bot commented Jul 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

aheckmann commented Aug 1, 2025 •

edited

Loading