docs: fix documentation inconsistencies with v0.23.0 codebase#651
Open
bfjelds wants to merge 5 commits into
Open
docs: fix documentation inconsistencies with v0.23.0 codebase#651bfjelds wants to merge 5 commits into
bfjelds wants to merge 5 commits into
Conversation
- gRPC Server: Add stable v1 UpdateService and CommitService to docs and architecture diagram (were shipped but undocumented) - Feature Matrix: Update gRPC API from planned to preview/supported, Rollback (systemd-boot/UKI) from planned to preview, add OCI registry image streaming row, add sysexts and confexts extensions row - Manual Rollback: Fix incorrect -ab flag to --ab (long flag only) - How Do I Interact: Add missing rollback command to CLI list - Trident main page: Move rollback to Servicing Features section (not applicable during clean install) - Future Developments: Add shipped features (confexts, runtime updates, disk streaming, OCI registry support), group confexts with sysexts - Sysexts: Update SELinux incompatibility note to cover confexts too Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bfjelds
force-pushed
the
user/bfjelds/mjolnir/fix-doc-inconsistencies
branch
from
48ba828 to
1121824
Compare
bfjelds
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation alignment pass to bring Trident’s published docs in sync with the v0.23.0 codebase, covering servicing capabilities (rollback, gRPC services, streaming), feature status, and developer workflows (testing/logging/deps).
Changes:
- Updates public Trident docs (feature matrix, future developments, CLI interaction) to reflect current servicing features (rollback, OCI streaming, sysexts/confexts, gRPC Update/Commit services).
- Refreshes explanation docs for sysexts SELinux constraints, manual rollback flags, and gRPC server service list/diagram.
- Corrects developer docs for structured error categories, PR/check guidance, logging standards examples, and testing/functional-test paths and metadata.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/Trident/Trident.md | Reorganizes feature bullets to separate servicing-only rollback. |
| docs/Trident/How-Do-I-Interact-With-Trident.md | Adds rollback to the CLI command list with a link to manual rollback docs. |
| docs/Trident/Future-Developments.md | Updates roadmap items to reflect shipped features (confexts, runtime updates, streaming, etc.). |
| docs/Trident/Feature-Matrix.md | Updates feature status icons; adds OCI streaming and sysexts/confexts row. |
| docs/Explanation/Sysexts.md | Expands SELinux incompatibility note to include confexts. |
| docs/Explanation/Manual-Rollback.md | Fixes rollback --ab flag documentation. |
| docs/Explanation/gRPC-Server.md | Documents stable v1 UpdateService/CommitService and updates architecture diagram. |
| docs/Development/Contributing/Structured-Error.md | Adds missing HealthChecks and UnsupportedConfiguration categories. |
| docs/Development/Contributing/Pull-Requests.md | Removes non-existent make rpm from PR checklist. |
| docs/Development/Contributing/Logging-Standards.md | Updates defaults and hash naming (SHA384); fixes referenced path. |
| docs/Development/Building/Testing.md | Updates make check description and functional-test feature flag name. |
| docs/Development/Building/Functional-Tests.md | Updates functional test root path; removes netlaunch mention; adds xfail/skip metadata fields. |
| docs/Development/Building/Dependencies.md | Adds ca-certificates and notes additional RPM-build dependencies. |
bfjelds
commented
May 22, 2026
frhuelsz
reviewed
May 22, 2026
frhuelsz
previously approved these changes
May 22, 2026
bfjelds
force-pushed
the
user/bfjelds/mjolnir/fix-doc-inconsistencies
branch
from
a69dc9d to
d060fd3
Compare
- Logging Standards: Fix default verbosity from WARN to DEBUG, update ImageSha256 references to ImageSha384, fix osutils path to include crates/ prefix - Testing: Fix make check description to include fmt/check/clippy, fix functional-tests feature flag to functional-test (singular) - Structured Error: Add missing HealthChecks and UnsupportedConfiguration ErrorKind variants (7 total, not 5) - Functional Tests: Fix root path from functional_tests/ to tests/functional_tests/, remove netlaunch reference from vm fixture, add xfail and skip fields to TestCaseMetadata, fix ft.json output path - Pull Requests: Remove non-existent make rpm target - Dependencies: Add ca-certificates and note additional RPM build packages (rpmdevtools, sed, perl, selinux-policy-devel) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bfjelds
force-pushed
the
user/bfjelds/mjolnir/fix-doc-inconsistencies
branch
from
d060fd3 to
ae79834
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
docs/Development/Building/Dependencies.md:34
- The protoc download URL is hard-coded to
linux-x86_64.zip, which will fail on arm64/aarch64 hosts (and this repo supportsaarch64). Consider selecting the correct protoc archive based onuname -m.
- Python 3.8+
- Python packages:
```bash
…ndards - Add unzip to apt install list (needed for protoc installation) - Clarify RPM build packages are for Azure Linux container, not Ubuntu host - Reword logging example to be clearly illustrative Co-authored-by: Copilot <223556219+Copilot@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.
Summary
Systematic documentation sweep comparing published docs against the v0.23.0 codebase. Fixes inaccurate flags, outdated feature statuses, missing error variants, and stale build instructions.
Public-facing docs
ollback\ command to CLI list
Development docs