Update doku - #10
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rewrites and substantially expands Readme.md to provide a more structured, narrative documentation for packtly-builder (features, architecture, getting started, and reference sections).
Changes:
- Replaces the README intro with a more detailed product/platform description and rationale (“Why not just debuild?”).
- Adds new structured sections: Features, Architecture diagrams, Getting Started, and Reference documentation.
- Reorganizes existing usage guidance into tables and subsections (components, container images, CLI reference, signing/credentials, development, versioning).
Comments suppressed due to low confidence (4)
Readme.md:112
- The “execute each stage individually” list doesn’t match what
just allactually runs: the pipeline ends withbuild-runtime-multiarch, notbuild-runtime. Usingbuild-runtimehere won’t produce the multi-arch manifest thatjust allcreates.
just build-builder
just test-tooling
just build-tooling
just build-runtime
Readme.md:197
- This line says images support only amd64/arm64, but the repository builds and publishes an armhf runtime image as well (see
.github/workflows/_build-runtime-image.ymlmatrix includesarch: armhf). The docs should reflect that armhf is supported (or clarify that the limitation is only for localjustmulti-arch builds).
All images support **amd64** and **arm64**.
Readme.md:273
- From the repo root there is no
tooling/directory; the Poetry project lives atpacktly-builder/tooling/. As written,cd toolingwill fail.
cd tooling
Readme.md:164
- The “Repository Layout” block doesn’t match the actual repo structure: there is no top-level
tooling/,tests/,container/,scripts/, orContainerfile— these live underpacktly-builder/(and the test directory istest/). Updating this block will prevent readers from trying paths that don’t exist.
packtly-builder/
├── tooling/ # Python CLI
├── tests/ # Unit and integration tests
├── container/ # Container definitions
├── Keys/ # Development signing keys
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
☂️ Code Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
Robot Results
Passed Tests
|
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.
No description provided.