Overview - Documentation contribution
How to improve OpenQuok documentation — fork the repo, author pages, and submit a pull request.
1 min read
Connect your agent today
Draft from chat, review in your calendar, and publish only what you approve.
Documentation contribution
This section is for anyone who wants to improve OpenQuok documentation — fix typos, add examples, clarify setup steps, or extend the docs site itself. You do not need to be a core maintainer; contributions via GitHub pull requests are welcome.
Use the sidebar or jump to a guide below.
Submit a pull request
Fork the repo, edit docs, preview locally, and open a PR on GitHub
Configuration
Site metadata, docs tabs, sidebar sections, TOC, and docs config files
Writing content
Pages, Markdown, Mermaid, FileTree, callouts, steps, and authoring conventions
Built-in components
Callouts, tabs, cards, badges, Mermaid, FileTree, and OpenAPI panels
Versioning
Optional version selector across doc deployments
Related Section(s)
General
What OpenQuok is and how to use the social scheduler
Getting Started
Architecture, quick start, and self-hosted defaults
Publish listings
Share building blocks and playbooks on the OpenQuok catalog
Developer guidelines
Conventions for auth, RBAC, SSR safety, and secrets handling
Configuration - Web
Vite env vars and web configuration