Skip to content

Commit 4942efc

Browse files
author
teycir
committed
docs: update README.md links for reorganized documentation structure
- Moved documentation files into subdirectories (core, deployment, security, testing, legal) for better organization - Updated all internal links in README.md to reflect new paths (e.g., docs/SELF-HOSTING.md → docs/deployment/SELF-HOSTING.md)
1 parent 68811e7 commit 4942efc

22 files changed

Lines changed: 24 additions & 24 deletions

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ After encryption, the file becomes ~750KB which fits within the 1MB database lim
535535
- Deploy your own instance
536536
- Configure `MAX_DURATION_DAYS` to any value
537537
- Remove auto-deletion cron job
538-
- See [SELF-HOSTING.md](docs/SELF-HOSTING.md)
538+
- See [SELF-HOSTING.md](docs/deployment/SELF-HOSTING.md)
539539

540540
```typescript
541541
// In your self-hosted instance
@@ -617,7 +617,7 @@ Contact for commercial licensing: [https://teycirbensoltane.tn](https://teycirbe
617617

618618
### How do I self-host Time-Seal?
619619

620-
See [SELF-HOSTING.md](docs/SELF-HOSTING.md) for complete guide.
620+
See [SELF-HOSTING.md](docs/deployment/SELF-HOSTING.md) for complete guide.
621621

622622
**Requirements:**
623623

@@ -778,7 +778,7 @@ Stage 4 (Week 4): "Final Exam [link]"
778778
**✅ Warrant Canary** - Live transparency status at /canary
779779
**✅ Self-Hosting** - Deploy your own instance to eliminate infrastructure trust
780780

781-
See [HARDENING.md](docs/HARDENING.md) for full details.
781+
See [HARDENING.md](docs/security/HARDENING.md) for full details.
782782

783783
### 🕊️ Warrant Canary - Transparency by Design
784784

@@ -936,35 +936,35 @@ wrangler secret put MASTER_ENCRYPTION_KEY
936936
## 📚 Documentation
937937

938938
### Core Documentation
939-
- [API Reference](docs/API.md) - Complete REST API documentation
940-
- [Architecture Guide](docs/ARCHITECTURE.md) - Design patterns and abstractions
941-
- [Reusable Libraries](docs/REUSABLE-LIBRARIES.md) - Extracted library documentation
942-
- [Libraries Quick Reference](docs/LIBRARIES-QUICK-REF.md) - Quick reference cheat sheet
939+
- [API Reference](docs/core/API.md) - Complete REST API documentation
940+
- [Architecture Guide](docs/core/ARCHITECTURE.md) - Design patterns and abstractions
941+
- [Reusable Libraries](docs/core/REUSABLE-LIBRARIES.md) - Extracted library documentation
942+
- [Libraries Quick Reference](docs/core/LIBRARIES-QUICK-REF.md) - Quick reference cheat sheet
943943

944944
### Deployment & Operations
945-
- [Deployment Guide](docs/DEPLOYMENT.md) - Cloudflare setup instructions
946-
- [Self-Hosting Guide](docs/SELF-HOSTING.md) - Deploy your own instance
947-
- [Domain Migration Guide](docs/DOMAIN-MIGRATION-LEARNINGS.md) - Custom domain setup and troubleshooting
948-
- [Analytics Setup](docs/ANALYTICS.md) - Privacy-first analytics implementation
945+
- [Deployment Guide](docs/deployment/DEPLOYMENT.md) - Cloudflare setup instructions
946+
- [Self-Hosting Guide](docs/deployment/SELF-HOSTING.md) - Deploy your own instance
947+
- [Domain Migration Guide](docs/deployment/DOMAIN-MIGRATION-LEARNINGS.md) - Custom domain setup and troubleshooting
948+
- [Analytics Setup](docs/deployment/ANALYTICS.md) - Privacy-first analytics implementation
949949

950950
### Security
951-
- [Security Documentation](docs/SECURITY.md) - Threat model and security controls
952-
- [Defense Audit Report](docs/DEFENSE-AUDIT.md) - Comprehensive security audit (v1.0.0)
953-
- [Trust Assumptions](docs/TRUST-ASSUMPTIONS.md) - What you must trust to use TimeSeal
954-
- [Hardening Guide](docs/HARDENING.md) - Mitigations for highest-priority threats
955-
- [Security Enhancements](docs/SECURITY-ENHANCEMENTS.md) - Key rotation, upload limits, integrity
956-
- [Key Rotation Guide](docs/KEY-ROTATION.md) - Master key rotation procedures
957-
- [Security Testing](docs/SECURITY-TESTING.md) - Penetration testing guide
958-
- [Audit Logging](docs/AUDIT-LOGGING.md) - Immutable audit trail for all operations
951+
- [Security Documentation](docs/security/SECURITY.md) - Threat model and security controls
952+
- [Defense Audit Report](docs/security/DEFENSE-AUDIT.md) - Comprehensive security audit (v1.0.0)
953+
- [Trust Assumptions](docs/security/TRUST-ASSUMPTIONS.md) - What you must trust to use TimeSeal
954+
- [Hardening Guide](docs/security/HARDENING.md) - Mitigations for highest-priority threats
955+
- [Security Enhancements](docs/security/SECURITY-ENHANCEMENTS.md) - Key rotation, upload limits, integrity
956+
- [Key Rotation Guide](docs/security/KEY-ROTATION.md) - Master key rotation procedures
957+
- [Security Testing](docs/security/SECURITY-TESTING.md) - Penetration testing guide
958+
- [Audit Logging](docs/security/AUDIT-LOGGING.md) - Immutable audit trail for all operations
959959

960960
### Testing & Quality
961-
- [Testing Guide](docs/TESTING.md) - Complete testing documentation
962-
- [Testing Infrastructure](docs/TESTING-INFRASTRUCTURE.md) - Test setup and configuration
961+
- [Testing Guide](docs/testing/TESTING.md) - Complete testing documentation
962+
- [Testing Infrastructure](docs/testing/TESTING-INFRASTRUCTURE.md) - Test setup and configuration
963963

964964
### Legal & Transparency
965-
- [Transparency Reports](docs/TRANSPARENCY-REPORT-TEMPLATE.md) - Quarterly legal disclosure
966-
- [Changelog](docs/CHANGELOG.md) - Version history and changes
967-
- [TODO](docs/TODO.md) - Production readiness checklist
965+
- [Transparency Reports](docs/legal/TRANSPARENCY-REPORT-TEMPLATE.md) - Quarterly legal disclosure
966+
- [Changelog](docs/legal/CHANGELOG.md) - Version history and changes
967+
- [TODO](docs/legal/TODO.md) - Production readiness checklist
968968

969969
This project is licensed under the **Business Source License (BSL)**.
970970

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)