docs: rework docs structure, contents and diagrams - #43
Merged
Conversation
Replace the three client-side Mermaid diagrams (system-context C4, VM lifecycle, config precedence) with server-rendered PlantUML SVGs: - getting-started.md: C4 container diagram via vendored C4-PlantUML. - sandboxes.md: lifecycle diagram detailed from the source flow, showing opencode-version resolution, the reconfig decision and all user prompts (upgrade rebuild, home-volume, VM-recreate, daemon-restart), fresh-boot startup hooks/dockerd, and reap-on-last-client. - configuration.md: precedence diagram. Add a docs render step that builds each diagram to SVG before the Jekyll build, a portable 'make docs-diagrams' target, the PlantUML jar + JRE + truststore in the sandbox Dockerfile, and gitignore the generated SVGs and docs/superpowers working artifacts.
* created recipes and getting-started sections * expanded sidebar menus by default * added docs-serve make target for previewing/developing docs * simplified code while tracing lifecycle diagram steps
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
==========================================
+ Coverage 88.06% 88.45% +0.39%
==========================================
Files 86 86
Lines 5186 5172 -14
==========================================
+ Hits 4567 4575 +8
+ Misses 431 414 -17
+ Partials 188 183 -5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
What
Docs rework: restructured the docs tree, expanded contents, and rendered
architecture diagrams server-side with PlantUML (C4 context/container models,
config precedence, lifecycle).
Also included
While on this branch, the daemon-restart path was tightened so a config
provisioning failure during a restart decision preserves the currently-running
opencode daemon instead of restarting it against stale/partial config
(
internal/sandbox/vm/reconfig.go), with the surrounding test suite adaptedand extended:
setUpSandboxnow tracks whether provisioning succeeded and only callsrestartDaemonswhen it did (restoring the pre-refactor behaviour of keepingthe existing daemon on a write failure).
restartDaemonscallers to the changed signature.TestSetUpSandboxSkipsRestartOnProvisionErrorto guard the regression.Notes
This PR intentionally mixes the docs work with a small code change; if you'd
prefer them split, I can rebase the code change onto its own branch/PR.