index.md

semantic-links	skill-links related-artifacts write-markdown-docs docs/AGENTS.md docs/benchmarking.md docs/containers.md docs/packages.md docs/profiling.md docs/release_process.md docs/adrs/README.md docs/adrs/index.md docs/issues/README.md docs/pr-reviews/README.md docs/refactor-plans/closed/README.md docs/refactor-plans/drafts/README.md docs/refactor-plans/open/README.md

Torrust Tracker — Documentation Index

This is the entry point for all project documentation. For API documentation generated from source code, see the crate docs on docs.rs.

Guides

Operational and development guides for working with the tracker.

Document	Description
benchmarking.md	How to run and interpret the torrent-repository benchmarks
containers.md	Building and running the tracker with Docker / Podman
packages.md	Workspace package catalog, architecture layers, and dependency rules
profiling.md	CPU and memory profiling with Valgrind / kcachegrind
release_process.md	Branch strategy, versioning, and the staging → main release pipeline

Architecture Decisions (ADRs)

Records of significant architectural decisions, including context and consequences.

Document	Description
adrs/README.md	Index of all ADRs and guidance on writing new ones
adrs/index.md	Quick-reference table of every ADR

Issue Specifications

Structured specification documents linked to GitHub issues. Used for planning and tracking implementation work before and during development.

Location	Description
issues/README.md	Overview, folder structure, and workflow skill references
issues/drafts/	Specs not yet linked to a GitHub issue
issues/open/	Active specs for open GitHub issues
issues/closed/	Recently closed specs kept temporarily for reference

Refactor Plans

Specification documents for larger refactoring efforts, following the same lifecycle as issue specs (drafts → open → closed).

Location	Description
refactor-plans/drafts/	Draft refactor plans not yet tied to a GitHub issue
refactor-plans/open/	Active refactor plan specs
refactor-plans/closed/	Completed refactor plans kept for reference

PR Reviews

Records of notable pull request reviews and Copilot suggestion threads.

Document	Description
pr-reviews/README.md	Overview of the PR review archive

Skills and Conventions

Internal documentation on project-specific conventions used by both humans and AI agents.

Document	Description
skills/semantic-skill-link-convention.md	Frontmatter schema, skill-link marker catalog, and machine-readable metadata conventions

Templates

Canonical document templates. Copy the appropriate template when creating a new artifact of that type.

Template	Description
templates/ADR.md	Template for Architectural Decision Records
templates/EPIC.md	Template for EPIC issue specifications
templates/ISSUE.md	Template for task / bug / feature issue specifications
templates/REFACTOR-PLAN.md	Template for refactor plan specifications
templates/COPILOT-SUGGESTIONS-TEMPLATE.md	Template for recording Copilot PR review suggestions

Media

Images, diagrams, flamegraphs, benchmark reports, and sample torrent files used in documentation.

Location	Description
media/	Top-level media assets (flamegraphs, benchmark screenshots, sample torrents)
media/demo/	Screenshots and assets used in demo documentation
media/packages/	Package architecture diagrams

Licenses

Full license texts referenced by the project.

Location	Description
licenses/	AGPL-3.0 and MIT-0 license files