docs re-org, audit fixes, build fixes
This commit is contained in:
62
docs/modules/_template/README.md
Normal file
62
docs/modules/_template/README.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# <Module Name>
|
||||
|
||||
> One-line description of what this module does.
|
||||
|
||||
## Purpose
|
||||
|
||||
A brief paragraph (2-3 sentences) explaining the module's purpose, its primary responsibility, and why it exists in the StellaOps platform.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Architecture](./architecture.md) - Technical design and implementation details
|
||||
- [Operations](./operations/) - Operational runbooks and dashboards
|
||||
- [API Reference](./api/) - API documentation (if applicable)
|
||||
|
||||
## Status
|
||||
|
||||
| Attribute | Value |
|
||||
|-----------|-------|
|
||||
| **Maturity** | Production / Beta / Alpha |
|
||||
| **Last Reviewed** | YYYY-MM-DD |
|
||||
| **Maintainer** | Guild/Team Name |
|
||||
|
||||
## Key Features
|
||||
|
||||
- Feature 1: Brief description
|
||||
- Feature 2: Brief description
|
||||
- Feature 3: Brief description
|
||||
|
||||
## Dependencies
|
||||
|
||||
### Upstream (this module depends on)
|
||||
- **Authority** - Authentication and authorization
|
||||
- **Other Module** - Why this dependency exists
|
||||
|
||||
### Downstream (modules that depend on this)
|
||||
- **Other Module** - How they use this module
|
||||
|
||||
## Quick Start
|
||||
|
||||
```csharp
|
||||
// Minimal code example showing how to use this module
|
||||
var builder = Host.CreateApplicationBuilder(args);
|
||||
builder.Services.Add<ModuleName>Services();
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
# Minimal configuration example
|
||||
module_name:
|
||||
setting_1: value
|
||||
setting_2: value
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Implementation Guides](../../<category>/) - If applicable
|
||||
- [Related Module](../other-module/) - Cross-references
|
||||
|
||||
## Notes
|
||||
|
||||
Any important caveats, migration notes, or known issues.
|
||||
Reference in New Issue
Block a user