docs: restructure README into quickstart-style docs layout - #18
Merged
Hadar301 merged 2 commits intoJul 28, 2026
Merged
Conversation
Replace the mega-README with a short landing page and move lasting content into docs/, so install paths stay in the deploy READMEs.
- Add slim ROSA OVN/Neuron troubleshooting, enrich ARO vs ROSA key differences with current vLLM/parser pointers, and link them from docs/models-and-routing.md.
itay1551
approved these changes
Jul 28, 2026
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
2 participants
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
Restructure documentation to match rh-ai-quickstart style: short root README (description → requirements → deploy → tags) and lasting detail under
docs/. Removes the mega-README lab dump and redundant ARO overview so install paths stay in the deploy READMEs.Related Issues / Tickets
Type of Change
Changes
README.md— Replace ~4100-line research/lab dump with a short quickstart landing page linking to three deploy paths anddocs/docs/— Add architecture, requirements, IDE/extensions, models/routing, benchmarks summary, customization; move architecture diagrams todocs/images/PCA_ARO.md— Delete; merge ROSA vs ARO deltas intoPCA_Deployment_ARO/README.mdtestresults_h100.md— Move underPCA_Deployment_ARO/; update README + script path referencesAGENTS.md— Point maintainers at user-facing README +docs/docs/models-and-routing.mdQuality Gates
yamllint,yamlfmt, secret scan)helm template) — N/A, docs-onlyVerification
Steps to verify:
README.mdon GitHub and confirm links to ROSA / ARO / existing-OpenShift /docs/*resolvePCA_ARO.mdand roottestresults_h100.md/images/are gone; diagrams load fromdocs/images/Local path check: 57 relative markdown links resolve;
docs/images/present on PR head (incl.architecture-traffic-flow.svg,redhat-components-view.png).