Phil Skentelbery
e589f5bd6c
This commit resolves all documentation issues identified in the comprehensive review: CRITICAL FIXES: - Renumbered duplicate ADRs to eliminate conflicts: * ADR-022-migration-race-condition-fix → ADR-037 * ADR-022-syndication-formats → ADR-038 * ADR-023-microformats2-compliance → ADR-040 * ADR-027-versioning-strategy-for-authorization-removal → ADR-042 * ADR-030-CORRECTED-indieauth-endpoint-discovery → ADR-043 * ADR-031-endpoint-discovery-implementation → ADR-044 - Updated all cross-references to renumbered ADRs in: * docs/projectplan/ROADMAP.md * docs/reports/v1.0.0-rc.5-migration-race-condition-implementation.md * docs/reports/2025-11-24-endpoint-discovery-analysis.md * docs/decisions/ADR-043-CORRECTED-indieauth-endpoint-discovery.md * docs/decisions/ADR-044-endpoint-discovery-implementation.md - Updated README.md version from 1.0.0 to 1.1.0 - Tracked ADR-021-indieauth-provider-strategy.md in git DOCUMENTATION IMPROVEMENTS: - Created comprehensive INDEX.md files for all docs/ subdirectories: * docs/architecture/INDEX.md (28 documents indexed) * docs/decisions/INDEX.md (55 ADRs indexed with topical grouping) * docs/design/INDEX.md (phase plans and feature designs) * docs/standards/INDEX.md (9 standards with compliance checklist) * docs/reports/INDEX.md (57 implementation reports) * docs/deployment/INDEX.md (deployment guides) * docs/examples/INDEX.md (code samples and usage patterns) * docs/migration/INDEX.md (version migration guides) * docs/releases/INDEX.md (release documentation) * docs/reviews/INDEX.md (architectural reviews) * docs/security/INDEX.md (security documentation) - Updated CLAUDE.md with complete folder descriptions including: * docs/migration/ * docs/releases/ * docs/security/ VERIFICATION: - All ADR numbers now sequential and unique (50 total ADRs) - No duplicate ADR numbers remain - All cross-references updated and verified - Documentation structure consistent and well-organized These changes improve documentation discoverability, maintainability, and ensure proper version tracking. All index files follow consistent format with clear navigation guidance. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
6.9 KiB
6.9 KiB
Architectural Decision Records (ADRs) Index
This directory contains all Architectural Decision Records for StarPunk CMS. ADRs document significant architectural decisions, their context, rationale, and consequences.
ADR Format
Each ADR follows this structure:
- Title: ADR-NNN-brief-descriptive-title.md
- Status: Proposed, Accepted, Deprecated, Superseded
- Context: Why we're making this decision
- Decision: What we decided to do
- Consequences: Impact of this decision
All ADRs (Chronological)
Foundation & Technology Stack (ADR-001 to ADR-009)
- ADR-001 - Python Web Framework Selection
- ADR-002 - Flask Extensions Strategy
- ADR-003 - Frontend Technology Stack
- ADR-004 - File-Based Note Storage
- ADR-005 - IndieLogin Authentication
- ADR-006 - Python Virtual Environment with uv
- ADR-007 - Slug Generation Algorithm
- ADR-008 - Versioning Strategy
- ADR-009 - Git Branching Strategy
Authentication & Authorization (ADR-010 to ADR-027)
- ADR-010 - Authentication Module Design
- ADR-011 - Development Authentication Mechanism
- ADR-016 - IndieAuth Client Discovery
- ADR-017 - OAuth Client Metadata Document
- ADR-018 - IndieAuth Detailed Logging
- ADR-019 - IndieAuth Correct Implementation
- ADR-021 - IndieAuth Provider Strategy
- ADR-022 - Auth Route Prefix Fix
- ADR-023 - IndieAuth Client Identification
- ADR-024 - Static Identity Page
- ADR-025 - IndieAuth PKCE Authentication
- ADR-026 - IndieAuth Token Exchange Compliance
- ADR-027 - IndieAuth Authentication Endpoint Correction
Error Handling & Core Features (ADR-012 to ADR-015)
- ADR-012 - HTTP Error Handling Policy
- ADR-013 - Expose Deleted-At in Note Model
- ADR-014 - RSS Feed Implementation
- ADR-015 - Phase 5 Implementation Approach
Micropub & API (ADR-028 to ADR-029)
Database & Migrations (ADR-020, ADR-031 to ADR-037)
- ADR-020 - Automatic Database Migrations
- ADR-031 - Database Migration System Redesign
- ADR-032 - Initial Schema SQL Implementation
- ADR-033 - Database Migration Redesign
- ADR-037 - Migration Race Condition Fix
- ADR-041 - Database Migration Conflict Resolution
Search & Advanced Features (ADR-034 to ADR-036, ADR-038 to ADR-040)
- ADR-034 - Full-Text Search
- ADR-035 - Custom Slugs
- ADR-036 - IndieAuth Token Verification Method
- ADR-038 - Syndication Formats (ATOM, JSON Feed)
- ADR-039 - Micropub URL Construction Fix
- ADR-040 - Microformats2 Compliance
Architecture Refinements (ADR-042 to ADR-044)
- ADR-042 - Versioning Strategy for Authorization Removal
- ADR-043 - CORRECTED IndieAuth Endpoint Discovery
- ADR-044 - Endpoint Discovery Implementation Details
Major Architectural Changes (ADR-050 to ADR-051)
v1.1.1 Quality & Production Readiness (ADR-052 to ADR-055)
- ADR-052 - Configuration System Architecture
- ADR-053 - Performance Monitoring Strategy
- ADR-054 - Structured Logging Architecture
- ADR-055 - Error Handling Philosophy
ADRs by Topic
Authentication & IndieAuth
ADR-005, ADR-010, ADR-011, ADR-016, ADR-017, ADR-018, ADR-019, ADR-021, ADR-022, ADR-023, ADR-024, ADR-025, ADR-026, ADR-027, ADR-036, ADR-043, ADR-044, ADR-050
Database & Migrations
ADR-004, ADR-020, ADR-031, ADR-032, ADR-033, ADR-037, ADR-041
API & Micropub
ADR-028, ADR-029, ADR-039
Content & Features
ADR-007, ADR-013, ADR-014, ADR-034, ADR-035, ADR-038, ADR-040
Development & Operations
ADR-001, ADR-002, ADR-003, ADR-006, ADR-008, ADR-009, ADR-012, ADR-015, ADR-042, ADR-051, ADR-052, ADR-053, ADR-054, ADR-055
Superseded ADRs
These ADRs have been superseded by later decisions:
- ADR-030 (old) - Superseded by ADR-043 (CORRECTED IndieAuth Endpoint Discovery)
How to Create a New ADR
- Find the next sequential number: Check the highest existing ADR number
- Use the naming format:
ADR-NNN-brief-descriptive-title.md - Follow the template:
# ADR-NNN: Title ## Status Proposed | Accepted | Deprecated | Superseded ## Context Why are we making this decision? ## Decision What have we decided to do? ## Consequences What are the positive and negative consequences? ## Alternatives Considered What other options did we evaluate? - Update this index with the new ADR
Related Documentation
- ../architecture/ - Architectural overviews and system design
- ../design/ - Detailed design documents
- ../standards/ - Coding standards and conventions
Last Updated: 2025-11-25 Maintained By: Documentation Manager Agent Total ADRs: 55