Documentation Request
The README provides basic usage, but comprehensive documentation for advanced features is needed.
Missing Documentation
-
API Reference
- REST endpoints documentation
- WebSocket event types
- Authentication methods
- Rate limiting details
-
Configuration Guide
- All available config options
- Environment variables
- Provider-specific settings
- Performance tuning
-
Deployment Guides
- Kubernetes deployment
- Docker Compose setup
- High availability configuration
- Monitoring setup
-
Tutorials
- Multi-account AWS setup
- Azure Management Groups
- GCP Organization scanning
- Terragrunt workflows
-
Architecture Documentation
- System design
- Data flow diagrams
- Security model
- Plugin development
Suggested Structure
docs/
├── getting-started/
│ ├── installation.md
│ ├── quick-start.md
│ └── first-drift-detection.md
├── guides/
│ ├── aws-setup.md
│ ├── azure-setup.md
│ ├── gcp-setup.md
│ └── terragrunt.md
├── reference/
│ ├── cli-commands.md
│ ├── api-reference.md
│ ├── configuration.md
│ └── environment-variables.md
├── deployment/
│ ├── kubernetes.md
│ ├── docker.md
│ └── high-availability.md
└── development/
├── architecture.md
├── contributing.md
└── plugin-development.md
I'm willing to help write some of these docs if you can provide the technical details.
Documentation Request
The README provides basic usage, but comprehensive documentation for advanced features is needed.
Missing Documentation
API Reference
Configuration Guide
Deployment Guides
Tutorials
Architecture Documentation
Suggested Structure
I'm willing to help write some of these docs if you can provide the technical details.