Skip to content

docs: migrate from Scalar to Docusaurus + OpenAPI#3

Open
anmho wants to merge 3 commits intomainfrom
docs/docusaurus
Open

docs: migrate from Scalar to Docusaurus + OpenAPI#3
anmho wants to merge 3 commits intomainfrom
docs/docusaurus

Conversation

@anmho
Copy link
Copy Markdown
Owner

@anmho anmho commented Apr 13, 2026

Summary

  • Replace Scalar docs delivery with a Docusaurus site under website/.
  • Keep curated CLI docs as hand-authored pages.
  • Generate API reference from docs/openapi.yaml using docusaurus-plugin-openapi-docs.
  • Update root scripts (docs:dev, docs:build, docs:validate) to use Docusaurus.
  • Update Pages workflow to build and deploy website/build.
  • Remove stale Scalar/Mintlify artifacts and old generated API MDX pages.

Key Details

  • API docs are generated at build/start time via npm --prefix website run api:gen.
  • Generated API docs are not committed (website/docs/api is gitignored).
  • Source OpenAPI remains pinned at docs/openapi.yaml (upstream BlueBubbles spec copy).

Publishing Behavior

  • GitHub Pages publishes from main, not from this PR branch.
  • After merge, docs will publish to: https://anmho.github.io/bluebubbles-cli/
  • This PR includes the workflow changes needed for Docusaurus Pages deploy.

Validation

  • bun run check
  • bun run docs:validate
  • npm --prefix website run build

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: cb144e0c49

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread package.json
"docs:validate": "test -f scalar/index.html",
"docs:dev": "npm --prefix website run start",
"docs:build": "npm --prefix website run build",
"docs:validate": "npm --prefix website run build",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Make docs scripts install website dependencies first

On a clean checkout, bun install only installs the root package, so bun run docs:validate now fails with docusaurus: not found because website/node_modules is never installed before running npm --prefix website run build. This regression makes the documented docs workflow unusable unless contributors know to run an extra manual install step (npm --prefix website ci) first.

Useful? React with 👍 / 👎.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 13, 2026

✅ Docusaurus preview build is ready.

  1. Open the workflow run: https://github.com/anmho/bluebubbles-cli/actions/runs/24339700114
  2. Download the docs-preview artifact
  3. Unzip and open locally (for example npx serve <unzipped-dir>)

This artifact is generated from the PR branch and can be reviewed before merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant