Contributing

We welcome contributions to the QuantaJS documentation site.

Contributing to the library

Looking to contribute to QuantaJS itself rather than the documentation? See the library's CONTRIBUTING.md and check the core issue tracker. The rest of this guide covers contributing to this documentation site.

Getting Started

1

Fork the Repository

Fork quanta-js/quanta-docs on GitHub.

2

Clone Your Fork

Clone your fork:

git clone https://github.com/<your-username>/quanta-docs.git
cd quanta-docs
3

Install Dependencies

Use Node.js 22 or later, then install dependencies:

npm install
4

Start the Development Server

npm run dev
5

Open the Site

Add or edit a documentation page

Documentation pages live at:

contents/docs/<section>/<page>/index.mdx

To add a new page:

  1. Create its index.mdx file with title and description frontmatter.
  2. Add the page to lib/routes-config.ts in the appropriate section.
  3. Run the development server and confirm the page appears in the sidebar.
  4. Run npm run build before opening the pull request.

The sidebar order in lib/routes-config.ts also drives previous/next navigation.

MDX components

The site registers reusable MDX components in lib/markdown.ts. Available components include:

  • Note
  • Tabs, TabsList, TabsTrigger, and TabsContent
  • Stepper and StepperItem
  • Callout
  • Files
  • Outlet

Use the existing docs pages as examples when choosing a component.

Blog posts

Blog posts live in contents/blogs/ as .mdx files. Their frontmatter includes:

  • title
  • description
  • date
  • authors
  • cover

Place referenced cover images under public/ and keep the frontmatter path in sync with the asset.

Submitting Changes

  • Open a pull request with a clear description of the change.
  • Follow the repository's Conventional Commit style.
  • Run npm run build for documentation or site changes.

Find a first issue

Reporting Issues

License

Contributions are licensed under the MIT License.

Spot something that needs improving?

Edit page