mirror of
https://github.com/pacnpal/thrillwiki_django_no_react.git
synced 2025-12-24 15:31:09 -05:00
ca770d76ff
- Updated backend README.md to include detailed management commands for configuration, database operations, cache management, data management, user authentication, content/media handling, trending/discovery, testing/development, and security/auditing. - Added a new MANAGEMENT_COMMANDS.md file for comprehensive command reference. - Included logging standardization details in architecture documentation (ADR-007). - Improved production checklist with configuration validation and cache verification steps. - Expanded API documentation to include error logging details. - Created a documentation review checklist to ensure completeness and accuracy.
1.9 KiB
1.9 KiB
Architecture Decision Records (ADRs)
This directory contains Architecture Decision Records (ADRs) documenting the key architectural decisions made in the ThrillWiki project.
What is an ADR?
An Architecture Decision Record is a document that captures an important architectural decision made along with its context and consequences.
Related Documentation
- Future Work - Deferred features and implementation plans
ADR Index
| ADR | Title | Status | Date |
|---|---|---|---|
| ADR-001 | Django + HTMX Architecture | Accepted | 2025-01 |
| ADR-002 | Hybrid API Design Pattern | Accepted | 2025-01 |
| ADR-003 | State Machine Pattern | Accepted | 2025-01 |
| ADR-004 | Caching Strategy | Accepted | 2025-01 |
| ADR-005 | Authentication Approach | Accepted | 2025-01 |
| ADR-006 | Media Handling with Cloudflare | Accepted | 2025-01 |
| ADR-007 | Logging Standardization Pattern | Accepted | 2025-01 |
ADR Template
New ADRs should follow this template:
# ADR-XXX: Title
## Status
[Proposed | Accepted | Deprecated | Superseded]
## Context
What is the issue that we're seeing that is motivating this decision or change?
## Decision
What is the change that we're proposing and/or doing?
## Consequences
What becomes easier or more difficult to do because of this change?
## Alternatives Considered
What other options were considered and why were they rejected?
Decision Status
- Proposed: The decision is under discussion
- Accepted: The decision has been accepted and implemented
- Deprecated: The decision is no longer relevant
- Superseded: The decision has been replaced by a newer ADR