@@ -14,15 +14,15 @@ A comprehensive, self-contained development environment providing Git hosting (F
1414## ✨ Key Features
1515
1616- ** 🚀 [ Complete Infrastructure] ( #️-architecture ) ** - Everything you need: Git, databases, caching, messaging, secrets, observability
17- - ** 🎯 [ Service Profiles] ( ./docs/SERVICE_PROFILES.md ) ** - Choose your stack: minimal (2GB), standard (4GB), or full (6GB) with observability
17+ - ** 🎯 [ Service Profiles] ( Service-Configuration ) ** - Choose your stack: minimal (2GB), standard (4GB), or full (6GB) with observability
1818- ** 🍎 [ Apple Silicon Optimized] ( #-prerequisites ) ** - Native ARM64 support via Colima's Virtualization.framework
19- - ** 🔒 [ Vault-First Security] ( ./docs/VAULT.md ) ** - All credentials managed by HashiCorp Vault with AppRole authentication
19+ - ** 🔒 [ Vault-First Security] ( Vault-Integration ) ** - All credentials managed by HashiCorp Vault with AppRole authentication
2020- ** 🛡️ [ AppRole Authentication] ( #-security--approle-authentication ) ** - Zero hardcoded secrets, least-privilege access for all core services
2121- ** 🔐 [ TLS/SSL Support] ( ./docs/TLS_CERTIFICATE_MANAGEMENT.md ) ** - Dual-mode TLS with automated certificate generation via Vault PKI
2222- ** 📦 [ Zero Cloud Dependencies] ( #-zero-cloud-dependencies ) ** - Runs entirely on your Mac, perfect for offline development
23- - ** 🛠️ [ Easy Management] ( ./docs/PYTHON_MANAGEMENT_SCRIPT.md ) ** - Single CLI script with 21 commands for all operations
24- - ** 📚 [ Reference Apps] ( ./reference-apps/README.md ) ** - Production-quality examples in Python, Go, Node.js, TypeScript, and Rust
25- - ** 🔍 [ Full Observability] ( ./docs/OBSERVABILITY.md ) ** - Built-in Prometheus, Grafana, and Loki for monitoring and logging
23+ - ** 🛠️ [ Easy Management] ( CLI-Reference ) ** - Single CLI script with 21 commands for all operations
24+ - ** 📚 [ Reference Apps] ( Development-Workflow ) ** - Production-quality examples in Python, Go, Node.js, TypeScript, and Rust
25+ - ** 🔍 [ Full Observability] ( Health-Monitoring ) ** - Built-in Prometheus, Grafana, and Loki for monitoring and logging
2626
2727## 🚀 Quick Start
2828
@@ -109,7 +109,7 @@ Choose the profile that fits your needs:
109109./devstack health
110110```
111111
112- ** See [ Service Profiles Guide] ( ./docs/SERVICE_PROFILES.md ) for detailed information.**
112+ ** See [ Service Profiles Guide] ( Service-Configuration ) for detailed information.**
113113
114114## 🛡️ Security & AppRole Authentication
115115
@@ -170,7 +170,7 @@ curl -X POST $VAULT_ADDR/v1/auth/approle/login \
170170# 6. Start service with fetched credentials
171171```
172172
173- ** See [ Vault Integration Guide] ( ./docs/VAULT.md ) for complete details.**
173+ ** See [ Vault Integration Guide] ( Vault-Integration ) for complete details.**
174174
175175## 🏗️ Architecture
176176
@@ -217,13 +217,13 @@ All reference apps demonstrate:
217217- Health checks and metrics
218218- TLS/SSL support
219219
220- ** See [ Reference Apps Overview] ( ./reference-apps/README.md ) for details.**
220+ ** See [ Reference Apps Overview] ( Development-Workflow ) for details.**
221221
222222## 💻 Usage
223223
224224### Management Commands
225225
226- The ` devstack ` script provides all essential operations:
226+ The ` manage- devstack` script provides all essential operations:
227227
228228``` bash
229229# Service management
@@ -391,40 +391,40 @@ DevStack Core is optimized for **local development** while maintaining patterns
391391## 📚 Documentation
392392
393393### Getting Started
394- - ** [ Installation Guide] ( ./docs/INSTALLATION.md ) ** - Comprehensive setup with troubleshooting
395- - ** [ Quick Start Tutorial] ( ./docs/USAGE.md ) ** - Step-by-step usage guide
396- - ** [ Service Profiles] ( ./docs/SERVICE_PROFILES.md ) ** - Profile selection and configuration
394+ - ** [ Installation Guide] ( Installation ) ** - Comprehensive setup with troubleshooting
395+ - ** [ Quick Start Tutorial] ( Quick-Start-Guide ) ** - Step-by-step usage guide
396+ - ** [ Service Profiles] ( Service-Configuration ) ** - Profile selection and configuration
397397
398398### Core Documentation
399- - ** [ Architecture Overview] ( ./docs/ARCHITECTURE.md ) ** - System design with diagrams
400- - ** [ Services Guide] ( ./docs/SERVICES.md ) ** - Detailed service configurations
401- - ** [ Management Script] ( ./docs/MANAGEMENT.md ) ** - Complete CLI reference
402- - ** [ Python CLI Guide] ( ./docs/PYTHON_MANAGEMENT_SCRIPT.md ) ** - Modern Python CLI documentation
399+ - ** [ Architecture Overview] ( Architecture-Overview ) ** - System design with diagrams
400+ - ** [ Services Guide] ( Service-Overview ) ** - Detailed service configurations
401+ - ** [ Management Script] ( Management-Commands ) ** - Complete CLI reference
402+ - ** [ Python CLI Guide] ( CLI-Reference ) ** - Modern Python CLI documentation
403403
404404### Infrastructure
405- - ** [ Vault Integration] ( ./docs/VAULT.md ) ** - PKI setup and secrets management
406- - ** [ Redis Cluster] ( ./docs/REDIS.md ) ** - Cluster architecture and operations
407- - ** [ Observability Stack] ( ./docs/OBSERVABILITY.md ) ** - Prometheus, Grafana, Loki setup
405+ - ** [ Vault Integration] ( Vault-Integration ) ** - PKI setup and secrets management
406+ - ** [ Redis Cluster] ( Redis-Cluster ) ** - Cluster architecture and operations
407+ - ** [ Observability Stack] ( Health-Monitoring ) ** - Prometheus, Grafana, Loki setup
408408
409409### Development
410- - ** [ Reference Apps Overview] ( ./reference-apps/README.md ) ** - Multi-language examples
411- - ** [ Best Practices] ( ./docs/BEST_PRACTICES.md ) ** - Development patterns
410+ - ** [ Reference Apps Overview] ( Development-Workflow ) ** - Multi-language examples
411+ - ** [ Best Practices] ( Best-Practices ) ** - Development patterns
412412- ** [ Testing Guide] ( ./tests/README.md ) ** - Testing infrastructure
413413- ** [ Test Coverage] ( ./tests/TEST_COVERAGE.md ) ** - Coverage metrics (571+ tests across 4 test suites)
414- - ** [ Testing Approach] ( ./docs/TESTING_APPROACH.md ) ** - Best practices for running tests
414+ - ** [ Testing Approach] ( Testing-Guide ) ** - Best practices for running tests
415415- ** [ Task 2.1 Testing] ( ./docs/.private/TASK_2.1_TESTING.md ) ** - Backup system test suite (63 tests)
416416
417417### Operations
418- - ** [ Troubleshooting] ( ./docs/TROUBLESHOOTING.md ) ** - Common issues and solutions
419- - ** [ Performance Tuning] ( ./docs/PERFORMANCE_TUNING.md ) ** - Optimization strategies
420- - ** [ Disaster Recovery] ( ./docs/DISASTER_RECOVERY.md ) ** - Backup and restore procedures
421- - ** [ Security Assessment] ( ./docs/SECURITY_ASSESSMENT.md ) ** - Security hardening
418+ - ** [ Troubleshooting] ( Common-Issues ) ** - Common issues and solutions
419+ - ** [ Performance Tuning] ( Debugging-Techniques ) ** - Optimization strategies
420+ - ** [ Disaster Recovery] ( Disaster-Recovery ) ** - Backup and restore procedures
421+ - ** [ Security Assessment] ( Certificate-Management ) ** - Security hardening
422422
423423### Project
424- - ** [ FAQ] ( ./docs/ FAQ.md ) ** - Frequently asked questions
425- - ** [ Changelog] ( ./.github/CHANGELOG.md ) ** - Version history
426- - ** [ Contributing] ( ./.github/CONTRIBUTING.md ) ** - Contribution guidelines
427- - ** [ Security Policy] ( ./.github/SECURITY.md ) ** - Security reporting
424+ - ** [ FAQ] ( FAQ ) ** - Frequently asked questions
425+ - ** [ Changelog] ( ./Changelog ) ** - Version history
426+ - ** [ Contributing] ( ./Contributing-Guide ) ** - Contribution guidelines
427+ - ** [ Security Policy] ( ./Secrets-Rotation ) ** - Security reporting
428428
429429## 🤝 Contributing
430430
@@ -446,7 +446,7 @@ We welcome contributions! Here's how to get started:
446446- Use conventional commit messages
447447- Ensure CI/CD checks pass
448448
449- ** See [ CONTRIBUTING.md] ( ./.github/CONTRIBUTING.md ) for detailed guidelines.**
449+ ** See [ CONTRIBUTING.md] ( ./Contributing-Guide ) for detailed guidelines.**
450450
451451## 🐛 Issues and Support
452452
@@ -457,8 +457,8 @@ We welcome contributions! Here's how to get started:
457457- System information (OS, Colima version, etc.)
458458
459459** Need help?**
460- 1 . Check the [ FAQ] ( ./docs/ FAQ.md )
461- 2 . Review [ Troubleshooting Guide] ( ./docs/TROUBLESHOOTING.md )
460+ 1 . Check the [ FAQ] ( FAQ )
461+ 2 . Review [ Troubleshooting Guide] ( Common-Issues )
4624623 . Search [ existing issues] ( https://github.com/NormB/devstack-core/issues )
4634634 . Ask in [ Discussions] ( https://github.com/NormB/devstack-core/discussions )
464464
@@ -485,7 +485,7 @@ Built with excellent open-source software:
485485- [ Prometheus] ( https://prometheus.io/ ) - Monitoring system
486486- [ Grafana] ( https://grafana.com/ ) - Observability platform
487487
488- ** See complete list:** [ ACKNOWLEDGEMENTS.md] ( ./docs/ACKNOWLEDGEMENTS.md )
488+ ** See complete list:** [ ACKNOWLEDGEMENTS.md] ( Acknowledgements )
489489
490490---
491491
0 commit comments