update project documentation

This commit is contained in:
Username
2025-12-20 17:20:40 +01:00
parent 713052de3d
commit 260d6e894d
5 changed files with 197 additions and 50 deletions

View File

@@ -4,45 +4,47 @@ Prioritized, actionable tasks. Each task is small and completable in one session
---
## Priority 1: Pending Commit
## Priority 1: Operations
| Status | Task
|--------|--------------------------------------------------------------
| ☐ | Commit abuse prevention feature (dedup changes in routes.py, config.py, database.py)
| ☐ | Commit documentation updates (api.md, README.md)
| ☐ | Add /metrics endpoint skeleton (for future Prometheus)
| ☐ | Add structured logging option via environment variable
## Priority 2: Test Coverage
## Priority 2: Features
| Status | Task
|--------|--------------------------------------------------------------
| ☐ | Run test suite, verify all tests pass
| ☐ | Add test for dedup window expiry behavior
| ☐ | Add test for concurrent identical submissions
| ☐ | Add test for MIME detection edge cases (empty content, truncated headers)
| ☐ | Measure and document test coverage percentage
| ☐ | Add paste listing for authenticated users
| ☐ | Add paste password protection
## Priority 3: Documentation
| Status | Task
|--------|--------------------------------------------------------------
| ☐ | Add deployment examples to documentation/deployment.md
| ☐ | Document environment variables in one canonical location
| ☐ | Add troubleshooting section to README.md
| ☐ | Add deployment examples (Kubernetes, systemd)
| ☐ | Create CONTRIBUTING.md with development setup
## Priority 4: Operations
## Priority 4: Testing
| Status | Task
|--------|--------------------------------------------------------------
| | Add SQLite WAL mode for better concurrency
| ☐ | Add /metrics endpoint skeleton (for future Prometheus)
| ☐ | Add structured logging option via environment variable
| ☐ | Optimize container build with multi-stage Containerfile
| | Add test for concurrent identical submissions
| ☐ | Add integration tests for container deployment
## Completed
| Date | Task
|------------|--------------------------------------------------------------
| 2024-12 | Implement burn-after-read option
| 2024-12 | Implement custom expiry per paste
| 2024-12 | Optimize Containerfile with multi-stage build
| 2024-12 | Implement E2E encryption in CLI (AES-256-GCM)
| 2024-12 | Implement entropy enforcement
| 2024-12 | Add /client endpoint for CLI download
| 2024-12 | Add URL prefix support
| 2024-12 | Implement proof-of-work spam prevention
| 2024-12 | Update documentation for v1.1.0
| 2024-12 | Add HEAD method for paste endpoints
| 2024-12 | Add SQLite WAL mode for better concurrency
| 2024-12 | Implement content-hash deduplication