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>
129 lines
5.2 KiB
Markdown
129 lines
5.2 KiB
Markdown
# Design Documentation Index
|
|
|
|
This directory contains detailed design documents, feature specifications, and phase implementation plans for StarPunk CMS.
|
|
|
|
## Project Structure
|
|
- **[project-structure.md](project-structure.md)** - Overall project structure and organization
|
|
- **[initial-files.md](initial-files.md)** - Initial file structure for the project
|
|
|
|
## Phase Implementation Plans
|
|
|
|
### Phase 1: Foundation
|
|
- **[phase-1.1-core-utilities.md](phase-1.1-core-utilities.md)** - Core utility functions and helpers
|
|
- **[phase-1.1-quick-reference.md](phase-1.1-quick-reference.md)** - Quick reference for Phase 1.1
|
|
- **[phase-1.2-data-models.md](phase-1.2-data-models.md)** - Data models and database schema
|
|
- **[phase-1.2-quick-reference.md](phase-1.2-quick-reference.md)** - Quick reference for Phase 1.2
|
|
|
|
### Phase 2: Core Features
|
|
- **[phase-2.1-notes-management.md](phase-2.1-notes-management.md)** - Notes CRUD functionality
|
|
- **[phase-2.1-quick-reference.md](phase-2.1-quick-reference.md)** - Quick reference for Phase 2.1
|
|
|
|
### Phase 3: Authentication
|
|
- **[phase-3-authentication.md](phase-3-authentication.md)** - Authentication system design
|
|
- **[phase-3-authentication-implementation.md](phase-3-authentication-implementation.md)** - Implementation details
|
|
- **[indieauth-pkce-authentication.md](indieauth-pkce-authentication.md)** - IndieAuth PKCE authentication design
|
|
|
|
### Phase 4: Web Interface
|
|
- **[phase-4-web-interface.md](phase-4-web-interface.md)** - Web interface design
|
|
- **[phase-4-quick-reference.md](phase-4-quick-reference.md)** - Quick reference for Phase 4
|
|
- **[phase-4-error-handling-fix.md](phase-4-error-handling-fix.md)** - Error handling improvements
|
|
|
|
### Phase 5: RSS & Deployment
|
|
- **[phase-5-rss-and-container.md](phase-5-rss-and-container.md)** - RSS feed and container deployment
|
|
- **[phase-5-executive-summary.md](phase-5-executive-summary.md)** - Executive summary of Phase 5
|
|
- **[phase-5-quick-reference.md](phase-5-quick-reference.md)** - Quick reference for Phase 5
|
|
|
|
## Feature-Specific Design
|
|
|
|
### Micropub API
|
|
- **[micropub-endpoint-design.md](micropub-endpoint-design.md)** - Micropub endpoint detailed design
|
|
|
|
### Authentication Fixes
|
|
- **[auth-redirect-loop-diagnosis.md](auth-redirect-loop-diagnosis.md)** - Diagnosis of redirect loop issues
|
|
- **[auth-redirect-loop-diagram.md](auth-redirect-loop-diagram.md)** - Visual diagrams of the problem
|
|
- **[auth-redirect-loop-executive-summary.md](auth-redirect-loop-executive-summary.md)** - Executive summary
|
|
- **[auth-redirect-loop-fix-implementation.md](auth-redirect-loop-fix-implementation.md)** - Implementation guide
|
|
|
|
### Database Schema
|
|
- **[initial-schema-implementation-guide.md](initial-schema-implementation-guide.md)** - Schema implementation guide
|
|
- **[initial-schema-quick-reference.md](initial-schema-quick-reference.md)** - Quick reference
|
|
|
|
### Security
|
|
- **[token-security-migration.md](token-security-migration.md)** - Token security improvements
|
|
|
|
## Version-Specific Design
|
|
|
|
### v1.1.1
|
|
- **[v1.1.1/](v1.1.1/)** - v1.1.1 specific design documents
|
|
|
|
## Quick Reference Documents
|
|
|
|
Quick reference documents provide condensed, actionable information for developers:
|
|
- **phase-1.1-quick-reference.md** - Core utilities quick ref
|
|
- **phase-1.2-quick-reference.md** - Data models quick ref
|
|
- **phase-2.1-quick-reference.md** - Notes management quick ref
|
|
- **phase-4-quick-reference.md** - Web interface quick ref
|
|
- **phase-5-quick-reference.md** - RSS and deployment quick ref
|
|
- **initial-schema-quick-reference.md** - Database schema quick ref
|
|
|
|
## How to Use This Documentation
|
|
|
|
### For Developers Implementing Features
|
|
1. Start with the relevant **phase** document (e.g., phase-2.1-notes-management.md)
|
|
2. Consult the **quick reference** for that phase
|
|
3. Check **feature-specific design** docs for details
|
|
4. Reference **ADRs** in ../decisions/ for architectural decisions
|
|
|
|
### For Planning New Features
|
|
1. Review similar **phase documents** for patterns
|
|
2. Check **project-structure.md** for organization guidelines
|
|
3. Create new design doc following existing format
|
|
4. Update this index with the new document
|
|
|
|
### For Understanding Existing Code
|
|
1. Find the **phase** that implemented the feature
|
|
2. Read the design document for context
|
|
3. Check **ADRs** for decision rationale
|
|
4. Review implementation reports in ../reports/
|
|
|
|
## Document Types
|
|
|
|
### Phase Documents
|
|
Comprehensive plans for each development phase, including:
|
|
- Goals and scope
|
|
- Implementation tasks
|
|
- Dependencies
|
|
- Testing requirements
|
|
|
|
### Quick Reference Documents
|
|
Condensed information for rapid development:
|
|
- Key decisions
|
|
- Code patterns
|
|
- Common operations
|
|
- Gotchas and notes
|
|
|
|
### Feature Design Documents
|
|
Detailed specifications for specific features:
|
|
- Requirements
|
|
- API design
|
|
- Data models
|
|
- UI/UX considerations
|
|
|
|
### Diagnostic Documents
|
|
Problem analysis and solutions:
|
|
- Issue description
|
|
- Root cause analysis
|
|
- Solution design
|
|
- Implementation plan
|
|
|
|
## Related Documentation
|
|
- **[../architecture/](../architecture/)** - System architecture and overviews
|
|
- **[../decisions/](../decisions/)** - Architectural Decision Records (ADRs)
|
|
- **[../reports/](../reports/)** - Implementation reports
|
|
- **[../standards/](../standards/)** - Coding standards and conventions
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-11-25
|
|
**Maintained By**: Documentation Manager Agent
|