docs: rewrite top-level docs to match the post-cleanup reality#263
Merged
Conversation
User-facing entry-point docs were still describing the v2.0-beta-VNC
world. This sweep brings them in line with the Selkies-only, image-
pipeline-in-templates-repo state of the codebase. Mechanical scrub of
the rest of docs/ is deferred.
Updates:
- README.md rewritten — repo topology, Selkies-only streaming,
links to the templates / plugins / wiki sibling
repos, chrome-selkies as the bootstrap template
- ROADMAP.md rewritten — released v2.0, the active April 2026
rebuild items, v2.1/v3.0 outlook
- FEATURES.md 3 surgical fixes ("VNC tunneling" → Selkies
streaming, latency metric label)
- docs/ARCHITECTURE.md
core component descriptions updated, sequence
diagram for VNC streaming replaced by Selkies
HTTP/WebRTC proxy flow, mermaid diagram labels
and security text reflect the new path
- docs/TROUBLESHOOTING.md
"VNC Connection Issues" section rewritten as
"Streaming Connection Issues" with Selkies-shaped
symptoms, checks, and solutions; ToC entry updated
- docs/CONTROLLER_SPEC.md
example payload uses chrome-selkies/8080 instead
of lscr.io/linuxserver/firefox/3000
Moves:
- docs/MIGRATION_V1_TO_V2.md → docs/historical/MIGRATION_V1_TO_V2.md
v1 is gone; the doc has historical-only value
Verified: all four modules build clean (api, k8s-agent, docker-agent, ui).
Remaining VNC references in docs/ live in:
CHANGELOG.md (historical, leave alone)
docs/V2_BETA_RELEASE_NOTES.md (historical, candidate for historical/)
docs/V2_DEPLOYMENT_GUIDE.md (2293 lines — separate sweep)
docs/API_REFERENCE.md (1506 lines — likely auto-gen from OpenAPI)
docs/CONTROLLER_GUIDE.md (sample code with KasmVNC types)
docs/PLUGIN_API.md, docs/PLUGIN_ARCHITECTURE_REFERENCE.md
docs/COMMENTING_GUIDE.md
docs/DISASTER_RECOVERY.md, docs/RELEASE_CHECKLIST.md
docs/TESTING.md, docs/TESTING_GUIDE.md
docs/design/* (mostly architecture decision context — frozen)
docs/workflows/wave-planning.md (obsolete dev workflow)
github-actions
Bot
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User-facing entry-point docs were still describing the v2.0-beta-VNC world. This sweep brings them in line with the Selkies-only, image-pipeline-in-templates-repo state of the codebase. Mechanical scrub of the rest of `docs/` is deferred.
Updates
Moves
v1 is gone; the doc has historical-only value.
Verified
`go build ./...` clean for api / k8s-agent / docker-agent. `npm run build` clean for ui.
Remaining (deferred to future PRs)