Doc: Added 'Components', 'Runtime' arch sections#477
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds two new documentation sections to the architecture explanation, focusing on system components and runtime behavior. The changes restructure the existing installation documentation by moving detailed daemon information into dedicated sections, creating a more layered approach to architectural documentation.
Key changes:
- New "Components" section that provides in-depth coverage of workshopd daemon, LXD backend, interface management, and data architecture
- New "Runtime behavior" section detailing workshop launch processes, container layout, and operational workflows
- Restructured installation documentation to remove detailed daemon subsections and provide references to the new dedicated sections
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/explanation/architecture/runtime-behavior.rst |
New file providing detailed explanation of workshop launch processes, container layout, and system diagrams |
docs/explanation/architecture/installation.rst |
Restructured to move detailed daemon information to dedicated sections, added cross-references |
docs/explanation/architecture/index.rst |
Updated table of contents to include the two new architecture sections |
docs/explanation/architecture/components.rst |
New file detailing system architecture including workshopd daemon, LXD backend, interface management, and data architecture |
docs/.custom_wordlist.txt |
Added "validator" to the custom wordlist for spell checking |
dmitry-lyfar
requested changes
Sep 12, 2025
akcano
force-pushed
the
docs/arch
branch
3 times, most recently
from
ad0fb5a to
bde0283
Compare
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Publishing my notes on the components only.
akcano
force-pushed
the
docs/arch
branch
2 times, most recently
from
2587d2b to
60dc98f
Compare
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Components are nearly there, a few comments on the runtime behaviour.
akcano
force-pushed
the
docs/arch
branch
2 times, most recently
from
95c19b9 to
f69367d
Compare
dmitry-lyfar
approved these changes
Oct 22, 2025
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
A couple more thoughts, but I think it's ready to go overall. Thanks for bearing with me.
Co-authored-by: Dmitry Lyfar <69887876+dmitry-lyfar@users.noreply.github.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
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.
This is a draft; major rework not impossible.
Elaborate discussions of
workshopdare moved to the second part to provide layering of detail with each new section.