Features
doQumentation turns IBM Quantum's open-source content into an interactive learning platform with live code execution, IBM Cloud Code Engine, simulator mode, learning progress tracking, and support for 20 languages.
Content Library
381 Pages of Content
42 Tutorials, 171 Guides, 154 Course pages, and 14 Modules — all sourced from IBM Quantum's open-source Qiskit documentation.
Browse tutorials →Auto-Sync from Upstream
Content is automatically synced from IBM's GitHub repository, keeping tutorials and courses up to date with the latest Qiskit releases.
Structured Navigation
Auto-generated sidebars with collapsible categories. Tutorials, Guides, Courses, and Modules each have their own organized sidebar.
Live Code Execution
Run / Back Toggle
Every notebook page has a Run button that activates all code cells with a live Jupyter kernel. Click Back to return to the static view.
Four Execution Backends
Free remote execution via Binder or Google Colab, fast serverless kernels via IBM Cloud Code Engine, or full offline via Docker and RasQberry Pi. When multiple backends are available, choose which one to use from the Settings page.
Choose backend →IBM Cloud Code Engine
Serverless Jupyter kernel on your IBM Cloud account. Cold start in seconds instead of Binder's 10–25 minutes. Free tier covers roughly 14 hours per month.
Set up Code Engine →Workshop Mode
Run classroom workshops with up to 50 participants. Deploy multiple Code Engine instances and share a single URL — participants are automatically distributed with sticky sessions and automatic failover.
Workshop setup guide →Workshop Monitoring
Live dashboard with auto-refresh (30s) shows per-instance kernel counts, busy kernels, connections, memory usage, and uptime. Each instance exposes a /stats endpoint. Stress test script simulates concurrent users to find capacity limits before the class starts.
Settings dashboard →Open in Google Colab
Every notebook page has an 'Open in Colab' button for zero-install cloud execution. Opens translated notebooks when browsing in another language.
Cell Execution Feedback
Visual feedback on every cell: amber border while running, green when done, red on error. A legend appears in the toolbar when the kernel is ready.
Contextual Error Hints
Automatic detection of ModuleNotFoundError, NameError, and kernel disconnection. Actionable hints appear below the cell with suggested fixes. Every error includes a "Report this error" link that opens a pre-filled GitHub issue.
One-Click Pip Install
When a missing package is detected, a clickable 'Install' button appears. After install completes, the failed cell re-runs automatically.
Open in JupyterLab
Open any notebook in full JupyterLab. Binder launches show real-time phase tracking with elapsed timer and cache-miss warnings. Cancel anytime or get slow-phase alerts suggesting faster backends. Subsequent clicks reuse the same server instantly.
Run All & Restart
Run All executes every cell in order with a live progress counter. Stop after the current cell anytime. Restart gives you a fresh kernel without losing your Binder session.
IBM Quantum Integration
Credential Store
Save your IBM Quantum API token and CRN once in Settings. Stored locally in your browser with 7-day auto-expiry for security.
Set up credentials →Auto-Injection
Credentials are silently injected into the kernel on startup. No need to paste tokens into every notebook — just click Run.
Simulator Mode
Run all notebooks without an IBM Quantum account. Choose AerSimulator for ideal simulation, or pick from dozens of FakeBackends that model real device noise. Zero setup required.
Enable simulator →Execution Mode Badge
The toolbar shows which mode is active — the simulator name (e.g. 'FakeSherbrooke') or 'IBM Quantum' — so you always know how your code is running.
Learning & Progress
Progress Tracking
Pages you visit get a checkmark (✓) in the sidebar. Notebooks you execute get a play indicator (▶). Track your journey through the content.
Category Badges
Each sidebar category shows a badge like '3/10' so you can see progress at a glance. Click to clear per-section progress.
Resume Reading
The homepage shows a 'Continue where you left off' card with your last visited page and when you were there.
Go to homepage →Bookmarks
Star any page to bookmark it. Bookmarks appear on the homepage. Stored locally, up to 50 pages.
View bookmarks →Display Preferences
Adjust code font size (10–22px), toggle static cell outputs, and suppress Python warnings for cleaner output.
Adjust display →Onboarding Tips
First-time visitors see contextual tips — like "Click Run to execute code live" on notebook pages. Tips auto-dismiss after a few visits.
Multi-Language
20 Languages
The full site is available in 20 languages including German, Japanese, Spanish, French, and more. Each locale runs on its own subdomain with translated UI.
Automatic Fallback
Untranslated pages fall back to English with a banner in the reader's language, so no page is ever missing.
Search, UI & Deployment
Local Search
Full-text search across all 381 pages, works offline. Results appear instantly as you type.
Dark Mode
Full dark theme support. Circuit diagrams and Matplotlib outputs auto-invert for readability.
Video Embeds
Course videos with YouTube mapping for reliable playback. Falls back to IBM Video when YouTube is unavailable.
Docker Deployment
Multi-stage Docker build with CI/CD to GitHub Container Registry. Full stack (site + Jupyter) or lightweight static-only image.
Mobile Responsive
Hamburger navigation, horizontal code scrolling, and responsive card grids. Works on phones and tablets.
Math Rendering
KaTeX for fast, high-quality LaTeX math rendering across all content pages — equations, matrices, and quantum notation.