docs: align internal docs to enterprise standards
All checks were successful
CI / verify (push) Successful in 2m33s
All checks were successful
CI / verify (push) Successful in 2m33s
Add canonical operations/security/access/feature docs and fix path integrity to improve onboarding and incident readiness.
This commit is contained in:
@@ -1,57 +1,44 @@
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
# CBDDC Documentation
|
||||
|
||||
Welcome to the CBDDC documentation for **version 0.9.0**.
|
||||
|
||||
## What's New in v0.9.0
|
||||
|
||||
Version 0.9.0 brings enhanced ASP.NET Core support, improved EF Core runtime stability, and refined synchronization and persistence layers.
|
||||
|
||||
- **ASP.NET Core Enhancements**: Improved sample application with better error handling
|
||||
- **EF Core Stability**: Fixed runtime issues and improved persistence layer reliability
|
||||
- **Sync & Persistence**: Enhanced stability across all persistence providers
|
||||
- **Production Ready**: All features tested and stable for production use
|
||||
|
||||
See the [CHANGELOG](https://github.com/CBDDC/ZB.MOM.WW.CBDDC.Net/blob/main/CHANGELOG.md) for complete details.
|
||||
|
||||
## Documentation
|
||||
|
||||
### Getting Started
|
||||
* [**Getting Started**](getting-started.html) - Installation, basic setup, and your first CBDDC application
|
||||
|
||||
### Core Concepts
|
||||
* [Architecture](architecture.html) - Understanding HLC, Gossip Protocol, and P2P mesh networking
|
||||
* [API Reference](api-reference.html) - Complete API documentation and examples
|
||||
* [Querying](querying.html) - Data querying patterns and LINQ support
|
||||
|
||||
### Persistence & Storage
|
||||
* [Persistence Providers](persistence-providers.html) - SQLite, EF Core, PostgreSQL comparison and configuration
|
||||
* [Deployment Modes](deployment-modes.html) - Single-cluster deployment strategy
|
||||
|
||||
### Networking & Security
|
||||
* [Security](security.html) - Encryption, authentication, and secure networking
|
||||
* [Conflict Resolution](conflict-resolution.html) - LWW and Recursive Merge strategies
|
||||
* [Network Telemetry](network-telemetry.html) - Monitoring and diagnostics
|
||||
* [Dynamic Reconfiguration](dynamic-reconfiguration.html) - Runtime configuration and leader election
|
||||
* [Remote Peer Configuration](remote-peer-configuration.html) - Managing remote peers and tracking lifecycle
|
||||
* [Upgrade: Peer-Confirmed Pruning](upgrade-peer-confirmed-pruning.html) - Adoption and rollout notes
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
### Deployment & Operations
|
||||
* [Deployment (LAN)](deployment-lan.html) - Platform-specific deployment instructions
|
||||
* [Production Hardening](production-hardening.html) - Configuration, monitoring, and best practices
|
||||
* [Peer Deprecation & Removal Runbook](peer-deprecation-removal-runbook.html) - Operational deprecation/removal workflow
|
||||
|
||||
## Previous Versions
|
||||
|
||||
- [v0.8.x Documentation](v0.8/getting-started.html)
|
||||
- [v0.7.x Documentation](v0.7/getting-started.html)
|
||||
- [v0.6.x Documentation](v0.6/getting-started.html)
|
||||
|
||||
## Links
|
||||
|
||||
* [GitHub Repository](https://github.com/CBDDC/ZB.MOM.WW.CBDDC.Net)
|
||||
* [NuGet Packages](https://www.nuget.org/packages?q=CBDDC)
|
||||
* [Changelog](https://github.com/CBDDC/ZB.MOM.WW.CBDDC.Net/blob/main/CHANGELOG.md)
|
||||
# CBDDC Documentation
|
||||
|
||||
Welcome to the CBDDC documentation site.
|
||||
|
||||
## Canonical Operational Docs
|
||||
|
||||
- [Architecture](architecture.md)
|
||||
- [Deployment](deployment.md)
|
||||
- [Runbook](runbook.md)
|
||||
- [Security](security.md)
|
||||
- [Access and Permissions](access.md)
|
||||
- [Troubleshooting](troubleshooting.md)
|
||||
|
||||
## Feature Docs
|
||||
|
||||
- [Feature Inventory](features/README.md)
|
||||
- [Selective Collection Sync](features/selective-collection-sync.md)
|
||||
- [Peer-to-Peer Gossip Sync](features/peer-to-peer-gossip-sync.md)
|
||||
- [Secure Peer Transport](features/secure-peer-transport.md)
|
||||
- [Peer-Confirmed Pruning](features/peer-confirmed-pruning.md)
|
||||
|
||||
## Additional References
|
||||
|
||||
- [Getting Started](getting-started.md)
|
||||
- [API Reference](api-reference.md)
|
||||
- [Persistence Providers](persistence-providers.md)
|
||||
- [Deployment Modes](deployment-modes.md)
|
||||
- [Deployment (LAN)](deployment-lan.md)
|
||||
- [Production Hardening](production-hardening.md)
|
||||
- [Conflict Resolution](conflict-resolution.md)
|
||||
- [Network Telemetry](network-telemetry.md)
|
||||
- [Dynamic Reconfiguration](dynamic-reconfiguration.md)
|
||||
- [Remote Peer Configuration](remote-peer-configuration.md)
|
||||
- [Upgrade: Peer-Confirmed Pruning](upgrade-peer-confirmed-pruning.md)
|
||||
- [Peer Deprecation and Removal Runbook](peer-deprecation-removal-runbook.md)
|
||||
- [Database Sync Manager Design](database-sync-manager-design.md)
|
||||
|
||||
## Release History
|
||||
|
||||
See the [CHANGELOG](https://github.com/CBDDC/ZB.MOM.WW.CBDDC.Net/blob/main/CHANGELOG.md) for version-level changes.
|
||||
|
||||
Reference in New Issue
Block a user