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>
4.2 KiB
4.2 KiB
Architecture Documentation Index
This directory contains architectural documentation, system design overviews, component diagrams, and architectural patterns for StarPunk CMS.
Core Architecture
System Overview
- overview.md - Complete system architecture and design principles
- technology-stack.md - Current technology stack and dependencies
- technology-stack-legacy.md - Historical technology decisions
Feature-Specific Architecture
IndieAuth & Authentication
- indieauth-assessment.md - Assessment of IndieAuth implementation
- indieauth-client-diagnosis.md - IndieAuth client diagnostic analysis
- indieauth-endpoint-discovery.md - Endpoint discovery architecture
- indieauth-identity-page.md - Identity page architecture
- indieauth-questions-answered.md - Architectural Q&A for IndieAuth
- indieauth-removal-architectural-review.md - Review of custom IndieAuth removal
- indieauth-removal-implementation-guide.md - Implementation guide for removal
- indieauth-removal-phases.md - Phased removal approach
- indieauth-removal-plan.md - Overall removal plan
- indieauth-token-verification-diagnosis.md - Token verification diagnostic analysis
- simplified-auth-architecture.md - Simplified authentication architecture
- endpoint-discovery-answers.md - Endpoint discovery implementation Q&A
Database & Migrations
- database-migration-architecture.md - Database migration system architecture
- migration-fix-quick-reference.md - Quick reference for migration fixes
- migration-race-condition-answers.md - Race condition resolution Q&A
Syndication
- syndication-architecture.md - RSS feed and syndication architecture
Version-Specific Architecture
v1.0.0
- v1.0.0-release-validation.md - Release validation architecture
v1.1.0
- v1.1.0-feature-architecture.md - Feature architecture for v1.1.0
- v1.1.0-implementation-decisions.md - Implementation decisions
- v1.1.0-search-ui-validation.md - Search UI validation
- v1.1.0-validation-report.md - Overall validation report
v1.1.1
- v1.1.1-architecture-overview.md - Architecture overview for v1.1.1
Phase Documentation
- phase1-completion-guide.md - Phase 1 completion guide
- phase-5-validation-report.md - Phase 5 validation report
Review Documentation
- review-v1.0.0-rc.5.md - Architectural review of v1.0.0-rc.5
How to Use This Documentation
For New Developers
- Start with overview.md to understand the system
- Review technology-stack.md for current technologies
- Read feature-specific architecture docs relevant to your work
For Architects
- Review version-specific architecture for historical context
- Consult feature-specific docs when making changes
- Update relevant docs when architecture changes
For Contributors
- Read overview.md for system understanding
- Consult specific architecture docs for areas you're working on
- Follow patterns documented in architecture files
Related Documentation
- ../decisions/ - Architectural Decision Records (ADRs)
- ../design/ - Detailed design documents
- ../standards/ - Coding standards and conventions
Last Updated: 2025-11-25 Maintained By: Documentation Manager Agent