Documentation
Every document ships as plain Markdown.
The Quil docs live in the repo next to the code, so they version together. Every link on this page opens the canonical Markdown on GitHub — pull requests welcome on any of them.
Project context
README
Project overview, features, install instructions, and keybinding reference. Start here.
README.md
Vision
Why Quil exists, who it's for, and what problem the reboot-proof workspace promise solves.
VISION.md
PRD
Full product requirements: personas, user stories, success metrics, scope boundaries.
PRD.md
Architecture
Client-daemon model, PTY backends, IPC protocol, state persistence, ADRs.
ARCHITECTURE.md
Roadmap
Milestone-by-milestone progress from M1 foundation to v1.0.0 stable, plus future work.
ROADMAP.md
Changelog
Keep-a-Changelog formatted history of every release, from v0.1.0 through v1.0.0.
CHANGELOG.md
Authoring guides
Plugin reference
Complete TOML plugin schema: [plugin], [spawn], [keys], [resume], [error], [status] sections with examples.
docs/plugin-reference.md
Contributing
How to set up the dev environment, run tests, and submit a pull request.
CONTRIBUTING.md
Versioning
Semantic versioning policy driven by Conventional Commits — how version bumps work in this project.
VERSIONING.md
Future roadmap PRDs
Command palette
Fuzzy-search command bar accessible via Ctrl+Shift+P. Future milestone.
docs/roadmap/command-palette.md
Community plugins
A registry + discovery mechanism for user-contributed TOML plugins.
docs/roadmap/community-plugins.md
Session sharing
Read-only tunnel into a live Quil workspace so a collaborator can watch your panes in real time.
docs/roadmap/session-sharing.md
Process health
Liveness probes per pane with automatic restart policies. Think systemd for pane processes.
docs/roadmap/process-health.md
Tmux migration
Import tmux sessions — read ~/.tmux/resurrect/ and map them into Quil's workspace model.
docs/roadmap/tmux-migration.md
Workspace files
Declarative workspace definitions in quil.toml checked into project repos.
docs/roadmap/workspace-files.md
The backend (Go daemon) lives at cmd/quild/, the TUI client at cmd/quil/, and shared internals (PTY, IPC, state, plugins) under internal/. The plugin examples and test fixtures live at docs/.