docs: streamline README as concise landing page#412
Merged
Conversation
- Reduce README from 703 to 133 lines: quick start, supported distros, template snippet, doc index - Create docs/tutorial/installation.md: build methods, Debian packaging, prerequisites - Create docs/tutorial/usage-guide.md: CLI workflows, configuration, shell completion - Clarify binary output paths (go build vs earthly vs Debian package) - Clarify build output paths (./workspace vs /tmp/os-image-composer) - Remove ARM/aarch64 references (not yet claimed) - Eliminate overlap with CLI specification, link to it instead
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the README from a comprehensive 703-line reference into a concise 133-line landing page, with detailed content moved to new dedicated guides. The restructuring improves discoverability and creates a clearer user journey.
Changes:
- Condensed README to focus on quick start: what the tool is, supported distributions, 4-step setup, minimal template example, and documentation index
- Created comprehensive Installation Guide covering all build methods, package installation, and prerequisite setup
- Created Usage Guide covering CLI workflows, configuration, output paths, and practical examples
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Transformed into a concise landing page with quick start guide and documentation index |
| docs/tutorial/installation.md | New comprehensive guide for all installation methods and prerequisites |
| docs/tutorial/usage-guide.md | New practical guide for CLI commands, configuration, and template examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
arodage
added a commit
that referenced
this pull request
Feb 13, 2026
- Fix systemConfigs → systemConfig (singular) in all template examples - Fix os: emt → os: edge-microvisor-toolkit in EMT example - Replace placeholder package names with real ones (cloud-init, rsyslog) - Align indentation with actual template format (no list prefix)
yockgen
approved these changes
Feb 13, 2026
magerstam
approved these changes
Feb 13, 2026
kblaszczak-intel
approved these changes
Feb 13, 2026
- Fix systemConfigs → systemConfig (singular) in all template examples - Fix os: emt → os: edge-microvisor-toolkit in EMT example - Replace placeholder package names with real ones (cloud-init, rsyslog) - Align indentation with actual template format (no list prefix)
arodage
force-pushed
the
docs/streamline-readme-landing-page
branch
from
26ed44b to
c833f7a
Compare
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.
Merge Checklist
Description
Streamlines the README from 703 lines to ~133 lines, turning it into a clean landing page focused on the most common user journey: build the tool, compose an image.
Changes:
Key improvements:
./os-image-composervs./build/os-image-composervs system PATH)./workspace/...vs/tmp/os-image-composer/...)No code changes. Documentation only.
Any Newly Introduced Dependencies
None.
How Has This Been Tested?