Handle expired agreements and rewrite README
- Implement robust End User Agreement expiry detection and handling - Add graceful error recovery for failed accounts - Rewrite README.md to focus on user benefits - Add documentation guidelines to AGENTS.md
This commit is contained in:
15
AGENTS.md
15
AGENTS.md
@@ -190,4 +190,17 @@ mod tests {
|
||||
- **Structured Logging**: Use `tracing` with spans for operations
|
||||
- **Error Context**: Provide context in error messages for debugging
|
||||
- **Metrics**: Consider adding metrics for sync operations
|
||||
- **Log Levels**: Use appropriate log levels (debug, info, warn, error)
|
||||
- **Log Levels**: Use appropriate log levels (debug, info, warn, error)
|
||||
|
||||
## Documentation Guidelines
|
||||
|
||||
### README.md
|
||||
- **Keep High-Level**: Focus on user benefits and key features, not technical implementation details
|
||||
- **User-Centric**: Describe what the tool does and why users would want it
|
||||
- **Skip Implementation Details**: Avoid technical jargon, architecture specifics, or internal implementation that users don't need to know
|
||||
- **Feature Descriptions**: Use concise, benefit-focused language (e.g., "Robust Error Handling" rather than "Implements EUA expiry detection with multiple requisition fallback")
|
||||
|
||||
### Technical Documentation
|
||||
- **docs/architecture.md**: Detailed technical specifications, implementation details, and developer-focused content
|
||||
- **specs/**: Implementation planning, API specifications, and historical context
|
||||
- **Code Comments**: Use for implementation details and complex logic explanations
|
||||
Reference in New Issue
Block a user