docs: streamline beginner onboarding and add end-to-end examples#46
Open
zzwwji-lab wants to merge 2 commits into
Open
docs: streamline beginner onboarding and add end-to-end examples#46zzwwji-lab wants to merge 2 commits into
zzwwji-lab wants to merge 2 commits into
Conversation
zzwwji-lab
marked this pull request as ready for review
July 16, 2026 06:49
Collaborator
|
The |
Author
|
Thanks for the review! I’ve removed docs/README.md, moved the general documentation navigation and learning paths to the root-level README.md, and updated the related links accordingly. |
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.
What changed
README.md; thedocs/directory no longer has a separateREADME.md.to the repository README.
correctness check and an end-to-end explanation of the kernel, grid, mask,
driver, and compiler stages.
while adding audience, prerequisites, and outcomes to the IR and debugging
guides.
rvv_vec_add_elf.pyRISC-V/QEMU tutorial and arepository-based operator migration case study.
docs/05-Operator Migration.mdtodocs/05-Operator-Migration.md, updated relative links, and normalizedMarkdown line endings to LF.
Why
The previous docs exposed several competing entry points and sent beginners
into compiler internals too early. The first Host CPU example also did not
clearly distinguish native execution from RISC-V/QEMU, and the historical
vector-add pytest printed numerical differences without asserting correctness.
This revision keeps the existing technical material but gives first-time
Triton, MLIR, and RISC-V readers one shortest path to a verified result before
introducing contributor internals.
User and developer impact
Beginners can now run and understand one complete Host CPU example before
choosing an optional RISC-V/QEMU path. Kernel developers get a concrete
migration and failure-triage workflow. Compiler contributors retain the
detailed analysis, lowering, ABI, optimization, and benchmark references in an
explicitly advanced route.
PyTorch references are described as correctness baselines rather than
Triton-RISCV fallbacks, and Host/QEMU measurements are not presented as real
RISC-V hardware performance.
Validation
markdownlint-cli2: 0 errors across the documentation set.successfully.
git diff --check: passed.and benchmark guides.
backend, scripts, examples, performance helpers, and CI workflow.
The Linux Triton/Buddy build and QEMU workflow were not executed from this
Windows workspace; their documented commands and success criteria were
verified against repository sources.