Contribution Guide

Documentation

Content lives in the public docs repository (MDX + sidebar.json).

  1. Edit or add an MDX page under the correct folder.
  2. Update sidebar.json (and the website copy under qpub-website/data/sidebar.json if you maintain both).
  3. Follow terminology and writing rules in the docs repo README.md (rule 10: multi-language examples).
  4. Verify behavior against qpub-backend public routes, the REST API / Socket protocol, and official SDK repos (qpub-js, qpub-go) before documenting it.

For pages with runnable samples, use <ExampleScope>, <CodeExamples>, and <InstallExamples> as described in the README — do not add one-off JavaScript-only fences when other languages apply.

Official SDKs

Customer-facing SDK overview: SDKs.

SDKRepository
JavaScript / TypeScript / React (@qpub/sdk)qpubio/qpub-js
Goqpubio/qpub-go
  • File bugs and feature requests as GitHub issues on the relevant repo.
  • Prefer pull requests that include tests for SDK changes.
Edit this page on GitHub