Skip to content

Commit d120252

Browse files
committed
docs: fix broken documentation links in main README.
1 parent ca4e85a commit d120252

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This is a **private blockchain** for controlled environments where only authoriz
4444

4545
### Advanced Functions
4646
- **Export/Import**: Backup and restore complete blockchain with temporal consistency
47-
- **Indexing Coordination**: Prevent infinite loops and coordinate indexing operations - see [IndexingCoordinator examples](docs/INDEXING_COORDINATOR_EXAMPLES.md)
47+
- **Indexing Coordination**: Prevent infinite loops and coordinate indexing operations - see [IndexingCoordinator examples](docs/monitoring/INDEXING_COORDINATOR_EXAMPLES.md)
4848
- **Advanced Search System**: Multi-level search with TRUE exhaustive capabilities
4949
- **SearchSpecialistAPI**: Professional search API with password-based initialization
5050
- **Generic Search**: searchAll() function searches both encrypted and non-encrypted content
@@ -109,7 +109,7 @@ This is a **private blockchain** for controlled environments where only authoriz
109109
- **ExitUtil**: Test-compatible system exit handling
110110
- **BlockValidationUtil**: Utilities for block validation
111111
- **BlockValidationResult**: Representation of validation results
112-
- **FormatUtil**: Formatting of blockchain data for display - see [quality assessment](docs/FORMATUTIL_QUALITY_ASSESSMENT.md) | [technical analysis](docs/FORMAT_UTIL_ROBUSTNESS_ANALYSIS.md)
112+
- **FormatUtil**: Formatting of blockchain data for display - see [quality assessment](docs/reports/FORMATUTIL_QUALITY_ASSESSMENT.md) | [technical analysis](docs/reports/FORMAT_UTIL_ROBUSTNESS_ANALYSIS.md)
113113

114114
### 🔐 User-Friendly Encryption API
115115

@@ -124,7 +124,7 @@ This is a **private blockchain** for controlled environments where only authoriz
124124
- **💾 Storage Tiering**: Intelligent data placement with compression and optimization
125125
- **🔧 Chain Recovery**: Automated corruption detection and recovery mechanisms
126126
- **📈 Analytics**: Comprehensive reporting and metrics for blockchain operations
127-
- **🔧 Metadata Management**: Dynamic block metadata updates without modifying encrypted content - see [Metadata Management Guide](docs/METADATA_MANAGEMENT_GUIDE.md)
127+
- **🔧 Metadata Management**: Dynamic block metadata updates without modifying encrypted content - see [Metadata Management Guide](docs/data-management/METADATA_MANAGEMENT_GUIDE.md)
128128

129129
### Technical Features
130130
- **Persistence**: Database-agnostic architecture with JPA standard for ORM (using Hibernate as provider)
@@ -171,9 +171,9 @@ report.generateRecommendations(); // AI-driven suggestions
171171
System.out.println(report.getFormattedSummary()); // Rich output
172172
```
173173

174-
**📚 Documentation**:
175-
- **Quick Start**: [OFFCHAIN_INTEGRITY_REPORT_QUICK_START.md](docs/OFFCHAIN_INTEGRITY_REPORT_QUICK_START.md)
176-
- **Complete Guide**: [OFFCHAIN_INTEGRITY_REPORT_ROBUSTNESS_IMPROVEMENTS.md](docs/OFFCHAIN_INTEGRITY_REPORT_ROBUSTNESS_IMPROVEMENTS.md)
174+
**📚 Documentation**:
175+
- **Quick Start**: [OFFCHAIN_INTEGRITY_REPORT_QUICK_START.md](docs/recovery/OFFCHAIN_INTEGRITY_REPORT_QUICK_START.md)
176+
- **Complete Guide**: [OFFCHAIN_INTEGRITY_REPORT_ROBUSTNESS_IMPROVEMENTS.md](docs/reports/OFFCHAIN_INTEGRITY_REPORT_ROBUSTNESS_IMPROVEMENTS.md)
177177
- **Test Coverage**: 10 comprehensive tests covering thread safety, validation, and robustness
178178

179179
## 🛠️ Technologies Used
@@ -1626,11 +1626,11 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
16261626
## 📞 Support
16271627

16281628
For issues or questions:
1629-
1. Check the [TESTING.md](docs/TESTING.md) troubleshooting section
1629+
1. Check the [TESTING.md](docs/testing/TESTING.md) troubleshooting section
16301630
2. Verify your Java and Maven versions meet requirements
16311631
3. Run `./run_all_tests.zsh` to identify problems
16321632
4. Check console output for specific error messages
1633-
5. Review [TECHNICAL_DETAILS.md](docs/TECHNICAL_DETAILS.md) for implementation details
1633+
5. Review [TECHNICAL_DETAILS.md](docs/reference/TECHNICAL_DETAILS.md) for implementation details
16341634

16351635
### Getting Help
16361636
1. **Check this documentation** for common use cases and examples
@@ -1666,7 +1666,7 @@ mvn clean compile test-compile
16661666
**🚀 Ready to start?**
16671667

16681668
1. Run `./run_all_tests.zsh` to verify everything works perfectly
1669-
2. Try the practical examples in [EXAMPLES.md](docs/EXAMPLES.md) for your use case
1669+
2. Try the practical examples in [EXAMPLES.md](docs/getting-started/EXAMPLES.md) for your use case
16701670
3. Explore the comprehensive test suite to understand all features
16711671
4. Build your own blockchain application using the patterns provided!
16721672

@@ -1709,7 +1709,11 @@ See [Performance Optimization Plan](docs/reports/PERFORMANCE_OPTIMIZATION_PLAN.m
17091709

17101710
### Contribution Guidelines
17111711

1712-
We welcome contributions! Please see our [Contribution Guidelines](CONTRIBUTING.md) for details on how to contribute to this project.
1712+
We welcome contributions! For details on how to contribute to this project, please review the following:
1713+
- Follow the code style and patterns used in the codebase
1714+
- Ensure all tests pass before submitting changes
1715+
- Add tests for new features or bug fixes
1716+
- Update documentation as needed
17131717

17141718
---
17151719

0 commit comments

Comments
 (0)