Submit a pull request

Fork and clone

On GitHub, fork Ratimon/openquok-monorepo, then clone your fork locally:

git clone https://github.com/<your-username>/openquok-monorepo.git
cd openquok-monorepo
corepack enable
pnpm install

Replace <your-username> with your GitHub username.

Create a branch

Use a short, descriptive branch name (for example docs/fix-cli-auth or docs/add-mcp-example):

git checkout -b docs/your-topic

Edit documentation

Add or update files under web/src/content/docs/. Match the folder layout of the section you are contributing to — for example CLI pages under cli-usages/, setup guides under mcp-setup-guides/, or this section under documentation-contribution/.

If you add a new page, include front matter with title, description, and order so it appears correctly in the sidebar. See Writing content for paths, MDX components, and authoring conventions.

To preview locally, run the web app from the repo root (see Quick start):

pnpm --filter web dev

Open http://localhost:5173/docs and navigate to the page you changed.

Commit and push

Stage only the files you changed, write a clear commit message, and push to your fork:

git add web/src/content/docs/
git commit -m "docs: describe your change briefly"
git push -u origin docs/your-topic

Open a pull request

On GitHub, open a pull request from your branch into main on Ratimon/openquok-monorepo.

In the PR description:

• Summarize what you fixed or added and who it helps (CLI users, self-hosters, MCP clients, etc.).
• Link any related issue if one exists.
• Add a short Test plan checklist (for example: “Opened /docs/... locally and verified links and callouts render”).

Maintainers will review, suggest edits if needed, and merge when ready.