Guitar Prometheus Documentation

Guitar Prometheus Documentation

Project documentation for Guitar Prometheus — the desktop tool that imports Guitar Pro scores (MusicXML / .gp / .gpx) and converts them to MIDI with VST keyswitches.

The customer-facing sections (architecture, development, customer, API reference) are published as a rendered site at guitar-prometheus.nullfragment.dev on every push to mainline. That site is the canonical reading surface; this repo holds the authoritative source.

The agentic-context/ subtree stays repo-local — it’s AI-session state for agents that operate on this repo, not customer documentation, and is excluded from the rendered docs site.

---

Contents

Architecture

System context, component design, and the architectural decisions that shape the codebase.

Document	Description
Architecture Overview	Pipeline diagram, component layout, data flow

Development

Contributing guidelines, build / test instructions, coding rules, release tooling, and the wishlist of deferred features.

Document	Description
Building	Local build setup, dependencies, common targets
Building on Windows	MSVC + CMake instructions, portable-mode ZIP layout
Releases	scripts/build-release.*, CPack generators, smoke procedure
Testing	Test architecture, fixtures, running the suite
Coding Rules	Style, doc conventions, commit-message format
Code-Review Standards	Cross-cutting standards codified in Phases 19 / 20
Techniques	The base Technique set + extension cadence
Wishlist	Deferred / future work pulled from feature triage

Customer

User-facing documentation for the desktop application.

Document	Description
Getting Started	First-run walkthrough: open a project, export MIDI
Profile Binding	Bind VST profiles to parts, edit keyswitches + drum maps
Native Import	.gp / .gpx import + per-format technique coverage

API Reference

Auto-generated from Doxygen comments on every push to mainline. Output lives at documentation/api-reference/ (gitignored). The build script is documentation/scripts/build-api-docs.sh; it runs Doxygen → XML and then doxybook2 → Markdown.

---

Building the Docs Site Locally

For a fast iteration loop on doc changes, mirror the production pipeline:

brew install doxygen librsvg
# doxybook2 v1.5.0 — not in homebrew; grab the macOS binary from
# https://github.com/matusnovak/doxybook2/releases
scripts/preview-docs-site.sh        # stages + builds; output in docs-site/dist
cd docs-site && pnpm preview        # serves on :4321

scripts/preview-docs-site.sh is the canonical local mirror of the production fragmented-infra/public-sites Docker build. To regenerate only the API reference markdown without doing a full site build:

documentation/scripts/build-api-docs.sh