|
|
e589f5bd6c
|
docs: Fix ADR numbering conflicts and create comprehensive documentation indices
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>
|
2025-11-25 13:28:56 -07:00 |
|
|
|
8d593ca1b9
|
docs: add container deployment guide and implementation report
Complete Phase 5 containerization documentation:
- Add comprehensive container deployment guide (500+ lines)
- Document Podman and Docker deployment workflows
- Include reverse proxy setup for Caddy and Nginx
- Add troubleshooting, monitoring, and maintenance sections
- Document --userns=keep-id requirement for Podman
- Add backup/restore procedures
- Include performance tuning guidelines
- Add security best practices
Implementation report includes:
- Technical implementation details
- Testing results and metrics
- Challenge resolution (Podman permissions)
- Security and compliance verification
- Integration with RSS feed
- Lessons learned and recommendations
Updated CHANGELOG.md:
- Document container features in v0.6.0
- Add configuration variables
- List deployment capabilities
- Note Podman and Docker compatibility
Phase 5 containerization: 100% complete
|
2025-11-19 10:14:35 -07:00 |
|
