docs: deduplicate index.md by removing content covered in guides#461
Merged
docs: deduplicate index.md by removing content covered in guides#461
Conversation
Reduce docs/index.md from 628 to 81 lines. Removed duplicated content for build instructions, configuration, commands, shell completion, template format, and template examples — all already covered in installation.md, usage-guide.md, cli-specification.md, and os-image-composer-templates.md.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation landing page (docs/index.md) to act as a lightweight hub, removing duplicated content now covered by dedicated guides and linking readers to the right reference pages.
Changes:
- Replaces the long-form landing page content with a short description and Quick Start.
- Adds “Guides” and “Tutorials” tables linking to key documentation pages.
- Simplifies “Get Help”, “Contribute”, and “License” sections while preserving the Sphinx/ReadTheDocs toctree.
arodage
requested review from
kblaszczak-intel,
magerstam,
srmungar,
stevenhoenisch and
yockgen
and removed request for
kblaszczak-intel and
stevenhoenisch
wiwaszko-intel
approved these changes
Mar 4, 2026
Contributor
wiwaszko-intel
left a comment
wiwaszko-intel
left a comment
There was a problem hiding this comment.
Looks OK.
The two tables listing guides and tutorials seem to have mixed content (some articles from the tutorials section listed under Guides), but that, along with the other fixes can be solved later.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+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.
Merge Checklist
All boxes should be checked before merging the PR
Description
Reduces
docs/index.mdfrom ~628 lines to ~81 lines by removing duplicated content that is already covered in the dedicated guide pages created in PR #412:The landing page now acts as a hub that points readers to the right guide rather than duplicating their content.
Part of the documentation restructuring effort (see also PR #439, PR #446).
Any Newly Introduced Dependencies
None.
How Has This Been Tested?