mirror of
https://github.com/Monadical-SAS/reflector.git
synced 2026-02-04 09:56:47 +00:00
docs: docs website + installation (#778)
* feat: WIP doc (vibe started and iterated) * install from scratch docs * caddyfile.example * gitignore * authentik script * authentik script * authentik script * llm doc * authentik ongoing * more daily setup logs * doc website * gpu self hosted setup guide (no-mistakes) * doc review round * doc review round * doc review round * update doc site sidebars * feat(docs): add mermaid diagram support * docs polishing * live pipeline doc * move pipeline dev docs to dev docs location * doc pr review iteration * dockerfile healthcheck * docs/pr-comments * remove jwt comment * llm suggestion * pr comments * pr comments * document auto migrations * cleanup docs --------- Co-authored-by: Mathieu Virbel <mat@meltingrocks.com> Co-authored-by: Igor Loskutov <igor.loskutoff@gmail.com>
This commit is contained in:
48
docs/TODO.md
Normal file
48
docs/TODO.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Documentation TODO - PR #778 Review Comments
|
||||
|
||||
Remaining items from Tito's review. See CHANGES.md for completed items.
|
||||
|
||||
---
|
||||
|
||||
## Remaining Items
|
||||
|
||||
| File | Issue | Priority | Notes |
|
||||
|------|-------|----------|-------|
|
||||
| ~~`intro.md:10`~~ | ~~Add screenshots~~ | ~~Low~~ | ✅ **DONE** - Added transcript view screenshot |
|
||||
| `file-pipeline.md:47` | chunk_size example shows 30s | Low | Unclear what example config should show (~16s actual) |
|
||||
| ~~`self-hosted-gpu-setup.md:235`~~ | ~~systemd template in repo~~ | ~~Medium~~ | ✅ **REMOVED** - Systemd support removed entirely |
|
||||
| ~~`installation/overview.md:85`~~ | ~~uv tool install~~ | ~~Low~~ | ✅ **DONE** - Changed to `uv tool install modal` |
|
||||
| ~~`installation/overview.md:101`~~ | ~~"Why systemd?"~~ | ~~Low~~ | ✅ **REMOVED** - Systemd support removed entirely |
|
||||
| `installation/overview.md:271` | Caddyfile copy removal | Low | Keeping for clarity |
|
||||
|
||||
---
|
||||
|
||||
## Skipped (Decided Not To Fix)
|
||||
|
||||
| File | Issue | Reason |
|
||||
|------|-------|--------|
|
||||
| `installation/overview.md:40` | Model size requirements | Uncertain about exact requirements |
|
||||
| `installation/overview.md:136` | WebRTC ports | Handled by Daily/Whereby, not us |
|
||||
| `installation/overview.md:136` | Security section | Risk of incomplete/misleading docs |
|
||||
| `installation/overview.md:179` | AWS setup order | Low priority, works as-is |
|
||||
| `installation/overview.md:410` | Redundant next steps | Issue doesn't exist (file ends at 401) |
|
||||
|
||||
---
|
||||
|
||||
## Completed
|
||||
|
||||
See CHANGES.md for full list. Summary:
|
||||
|
||||
### Removals (9)
|
||||
- Encrypted data storage, session management, analytics claims
|
||||
- "coming soon" GPU, 30-second segments, CPU optimization
|
||||
- Encryption at rest, manual migrations, modprobe commands
|
||||
|
||||
### Fixes (9)
|
||||
- WebRTC + Daily/Whereby, 4 API endpoints, Docker docs link
|
||||
- NVIDIA steps merged, compose.yml referenced, cross-reference duplicate
|
||||
- tee→nano, MOV format, troubleshooting link
|
||||
|
||||
### Previously Fixed (7)
|
||||
- Blog removal, Daily.co added, rate limiting removed (x2)
|
||||
- PII claim removed, python→yaml, LUFS removed
|
||||
Reference in New Issue
Block a user