This documentation follows the Diataxis framework. Each document belongs to exactly one of four types: tutorials (learning by doing), how-to guides (working to a goal), reference (facts while working), or explanation (understanding why). Navigate by what you need right now.
Step-by-step lessons that build understanding through practice. Follow these when you are new to a topic and want to be guided through it end to end.
| Doc | Purpose |
|---|---|
| Foundry VTT First Setup | Install and configure the Pathfinder 2e Foundry module from scratch |
Practical recipes that assume you know the basics and need to accomplish a specific task. Dip in and out as needed.
| Doc | Purpose |
|---|---|
| Install Sentinel | Deploy the full stack with Docker Compose |
| Onboard a Player | Add a new player to the Pathfinder 2e module |
| Foundry + Forge + Tailscale | Expose a local Foundry instance through Forge and Tailscale |
| Troubleshoot Discord | Diagnose and fix common Discord bot issues |
| Troubleshoot Foundry | Diagnose and fix common Foundry VTT integration issues |
Accurate, up-to-date technical information. Use these when you need to look something up, not when you want to learn.
| Doc | Purpose |
|---|---|
| Feature Reference | Current shipped and planned capability list |
| Discord Commands | Every /sen command and subcommand with examples |
| API and Contracts | Sentinel Core HTTP API, message envelope schema, module protocol |
| Obsidian Vault Layout | Vault directory structure, frontmatter conventions, naming rules |
| Foundry Secrets and Ports | Secret file names, port assignments, and environment variables for Foundry |
Background reading that builds conceptual understanding. Not procedures — context and rationale.
| Doc | Purpose |
|---|---|
| Architecture | How the components fit together, design decisions, and request flow |
Architectural decision records (ADRs) capture the reasoning behind key design choices.
| ADR | Title |
|---|---|
| ADR-0001 | Sentinel persona source |
| ADR-0002 | Vault seam location |
| ADR-0003 | Recall module |
| ADR-0004 | Semantic recall |
| ADR-0005 | Typed session summary |