Add Sphinx documentation set - #160
Merged
Merged
Conversation
Adds a Sphinx/MyST doc set under docs/rocm-docs/ that single-sources content from README.md and walkthroughs/ via MyST include directives, covering installation, core concepts, and walkthroughs. Built for publishing to Read the Docs.
Comment on lines
+1
to
+2
| ```{include} ../../../walkthroughs/lemonade-router-builder.md | ||
| ``` |
Collaborator
There was a problem hiding this comment.
Can you tell me more about this file? Looks like it either should not be here given that no other walkthroughs are here.
Collaborator
Author
There was a problem hiding this comment.
This file single-sources the content from walkthroughs/lemonade-router-builder.md
- Absolute-ify GitHub-only relative links in README.md and two walkthrough tutorials so they resolve correctly whether viewed on GitHub or included into the doc site - Convert license.rst to a single-sourced license.md - Add a standalone Catalog topic and link it from the landing page and the What is a Skill? page, replacing GitHub-link workarounds - Add topic pages for the remaining six walkthroughs and link them from the walkthroughs index - Reorder navigation to Catalog, Install, What is a Skill?, Walkthroughs, License
pmoutsias-amd
force-pushed
the
docs/add-sphinx-documentation
branch
from
August 25, 2026 02:02
542991c to
a5cf3d8
Compare
…tion to Conceptual, group catalog under Reference and license under About
- Reorder left nav and landing tiles: Install, Conceptual, Walkthroughs, Reference (catalog), About (license)
- Rename the concepts section's nav caption from "What is a Skill?" to "Conceptual" so it's distinct from the page title
- Move the catalog page out of a standalone top-level "Catalog" caption into a "Reference" caption positioned after Walkthroughs
- Rename the license caption from "License" to "About"
- Fix a stale include anchor in install/installation.md ("## Manual Installation" -> "## Manual installation") that no longer matched the README heading
Revert the 7 walkthroughs/*.md source files' H1 back to their original "AMD Skills Walkthroughs: `<slug>`" form so they stand alone correctly when read directly on GitHub. The docs topic pages now supply their own bare-slug H1 and skip past the source heading with :start-after:, the same pattern already used by catalog.md and concepts/index.md, instead of relying on a bare full-file include whose title came from the source file's own heading.
pmoutsias-amd
requested review from
amitkumar-amd,
danielholanda and
peterjunpark
August 25, 2026 14:30
danielholanda
marked this pull request as ready for review
August 25, 2026 17:16
danielholanda
approved these changes
Aug 25, 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.
Adds a Sphinx documentation site under
docs/rocm-docs/, single-sourced fromREADME.mdandwalkthroughs/via MyST{include}directives so the docs and repo content stay in sync automatically.Covers installation, core concepts, the skill catalog, licensing, and all 7 walkthroughs, and is set up to publish on Read the Docs.
Also includes editorial pass of existing README content.
Updated some links to be absolute so they work in a RTD doc.