docs: split into user docs and developer guide, refresh content - #61
Merged
Conversation
Reorganise the public docs into a clear user/developer split and correct outdated information found while auditing every page. Structure (mkdocs nav): - User: Home, Why vstimd?, Getting started, Tutorials, Concepts, Client library (Python client, Web control UI), Running a rig (bare-metal, deployment) - Developer guide: Architecture, Rendering & DRM internals, Wire protocol, Server API, Building & packaging Move Rust-internals content (threading, render loop, scene state, DRM/Vulkan backends, module layout, packaging) out of the user-facing pages into the new developer guide; keep operator setup (systemd, kernel/DRM setup) in user docs. Fixes: - Correct repo URLs to github.com/braemons/vstimd (CI badge, git clone). - Overlay is the F1-F7 panel system (not a single F1 toggle); drop the stale "egui Vulkan renderer TODO" status. - Add Concepts > Saving & loading for the implemented config save/load feature; remove the broken saving-loading / scene-serialization links. - Replace the outdated message-by-message protocol reference with a short example, links to the .proto files as source of truth, and protobuf intro links. - Add placeholder Web control UI page (port 8080, online control + config). - Keep the not-yet-ready polygon stimulus out of user docs. mkdocs build --strict passes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ence links - Convert all remaining ASCII/box-drawing diagrams to mermaid (coordinate system, tutorial API-path overview, recording-integration, and the developer architecture server + render-loop diagrams). - Lay wide flowcharts out top-down (TB) so they use vertical space and stay readable instead of shrinking to fit the column; add a .mermaid overflow-x safeguard in extra.css. - Link ZeroMQ and DRM to their Wikipedia articles on first mention (index, why-vstimd, protocol page). Verified rendering with a headless browser; mkdocs build --strict passes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…itle Theme-aware (light/dark logo variants), sized modestly and kept as the page h1 so no duplicate 'Home' heading is inserted. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Low-latency/low-overhead ZeroMQ (no auth on the hot path), compact binary messages for performance, and protobuf for its near-universal language support. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Restructures the public documentation into a clear user docs vs. developer guide split and corrects outdated content found while auditing every page.
Structure (mkdocs nav)
Rust internals (threading, render loop, scene state, DRM/Vulkan backends, module layout, packaging) moved out of the user-facing pages into the developer guide; operator setup (systemd, kernel/DRM setup) stays in user docs.
Content fixes
github.com/braemons/vstimd(CI badge,git clone).saving-loading/scene-serializationlinks..protofiles as source of truth, protobuf-intro links, and a Why ZeroMQ + protobuf rationale.Cosmetics
.mermaidoverflow-x safeguard.Verified diagram rendering with a headless browser;
mkdocs build --strictpasses.🤖 Generated with Claude Code