From cab039a9d8094db63368645f41ce1865224ce3f0 Mon Sep 17 00:00:00 2001 From: Christopher Allen Lane Date: Sun, 15 Feb 2026 07:32:40 -0500 Subject: [PATCH] docs: move ADRs to project root, remove boilerplate README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move `doc/adr/` to `adr/` for discoverability. Remove the generic ADR README — `ls adr/` serves the same purpose. Co-Authored-By: Claude Opus 4.6 --- .../001-path-traversal-protection.md | 0 .../002-environment-variable-parsing.md | 0 .../adr => adr}/003-search-parallelization.md | 0 doc/adr/README.md | 38 ------------------- 4 files changed, 38 deletions(-) rename {doc/adr => adr}/001-path-traversal-protection.md (100%) rename {doc/adr => adr}/002-environment-variable-parsing.md (100%) rename {doc/adr => adr}/003-search-parallelization.md (100%) delete mode 100644 doc/adr/README.md diff --git a/doc/adr/001-path-traversal-protection.md b/adr/001-path-traversal-protection.md similarity index 100% rename from doc/adr/001-path-traversal-protection.md rename to adr/001-path-traversal-protection.md diff --git a/doc/adr/002-environment-variable-parsing.md b/adr/002-environment-variable-parsing.md similarity index 100% rename from doc/adr/002-environment-variable-parsing.md rename to adr/002-environment-variable-parsing.md diff --git a/doc/adr/003-search-parallelization.md b/adr/003-search-parallelization.md similarity index 100% rename from doc/adr/003-search-parallelization.md rename to adr/003-search-parallelization.md diff --git a/doc/adr/README.md b/doc/adr/README.md deleted file mode 100644 index 8d90f1f..0000000 --- a/doc/adr/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# Architecture Decision Records - -This directory contains Architecture Decision Records (ADRs) for the cheat project. - -## What is an ADR? - -An Architecture Decision Record captures an important architectural decision made along with its context and consequences. ADRs help us: - -- Document why decisions were made -- Understand the context and trade-offs -- Review decisions when requirements change -- Onboard new contributors - -## ADR Format - -Each ADR follows this template: - -1. **Title**: ADR-NNN: Brief description -2. **Date**: When the decision was made -3. **Status**: Proposed, Accepted, Deprecated, Superseded -4. **Context**: What prompted this decision? -5. **Decision**: What did we decide to do? -6. **Consequences**: What are the positive, negative, and neutral outcomes? - -## Index of ADRs - -| ADR | Title | Status | Date | -|-----|-------|--------|------| -| [001](001-path-traversal-protection.md) | Path Traversal Protection for Cheatsheet Names | Accepted | 2025-01-21 | -| [002](002-environment-variable-parsing.md) | No Defensive Checks for Environment Variable Parsing | Accepted | 2025-01-21 | -| [003](003-search-parallelization.md) | No Parallelization for Search Operations | Accepted | 2025-01-22 | - -## Creating a New ADR - -1. Copy the template from an existing ADR -2. Use the next sequential number -3. Fill in all sections -4. Include the ADR alongside the commit implementing the decision \ No newline at end of file