Skip to content

docs: add architecture, operations, and reference documentation#19

Merged
jrepp merged 1 commit intomainfrom
docs/add-architecture-operations
Nov 8, 2025
Merged

docs: add architecture, operations, and reference documentation#19
jrepp merged 1 commit intomainfrom
docs/add-architecture-operations

Conversation

@jrepp
Copy link
Owner

@jrepp jrepp commented Nov 8, 2025

Add comprehensive docs for architecture, deployment patterns, operations, monitoring, and API reference. Completes documentation restructuring.

Add comprehensive documentation for architecture and operations:

Architecture Documentation:
- Design decisions and rationale
- Scaling strategies for different workloads
- Storage architecture overview
- Storage optimization for AWS, GCP, and Azure

Operations Documentation:
- Deployment patterns (sidecar, namespace, sharded)
- Monitoring and observability guide
- Troubleshooting common issues
- Release procedures (moved from RELEASING.md)
- Testing guide (moved from TESTING.md)
- Upgrade procedures (moved from UPGRADING.md)

Reference Documentation:
- API reference
- Configuration options
- Metrics reference

Contributing:
- CONTRIBUTING.md with development guidelines
- CHANGELOG.md for tracking releases

This completes the documentation restructuring with all
operational and architectural information in docs/.
@jrepp jrepp force-pushed the docs/add-architecture-operations branch from b2519aa to e7b03f2 Compare November 8, 2025 08:03
@jrepp jrepp merged commit 57d5553 into main Nov 8, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant