Q10E Labs Public Docs

This directory hosts the public-facing documentation for Q10E Labs. The site is built with Sphinx and the Shibuya theme, and publishes to the public docs subdomain.

Related sites:

• Product/investor docs: https://product.q10elabs.thaumogen.net/
• Engineering docs: https://eng.q10elabs.thaumogen.net/

Prerequisites

• Python 3.12+
• GNU Make and pip

Local Setup

1. Create and activate the virtual environment:

   python3 -m venv venv
   source venv/bin/activate

2. Install Python dependencies:

   pip install -r docs/requirements.txt

Building the Site

• Build HTML documentation:

  make -C docs html

  The Sphinx build output is generated in docs/build/html.
• Clean previous outputs:

  make -C docs clean

Content Structure

• User Guide (docs/source/user-guide/) - End-user documentation
• Blog (docs/source/blog/) - Engineering notes for public consumption

Common Tasks

• Rebuild after editing documentation: make -C docs html
• Preview locally: open docs/build/html/index.html in a browser
• Add new pages: create .rst or .md files under docs/source/user-guide/ or docs/source/blog/