docs: consolidate 10 docs per language into 3 + bilingual index#11
Merged
docs: consolidate 10 docs per language into 3 + bilingual index#11
Conversation
Reorganize docs/ following triton-cpu/docs/riscv64 structure: - getting-started.md: build, launch, HIP test, GPU driver init - architecture.md: system design, memory sharing, GART, xGMI - reference.md: parameters, pitfalls, debugging, PTE layout Create docs/README.md bilingual index with Quick Links table. Update README.md and README.zh.md to reference new structure. Delete all 20 old doc files (10 per language). Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 33130540ae
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- Fix manual disk-image build path: cd gem5-resources/ (not ../gem5-resources/) - Align component diagram box borders in architecture.md (en+zh) - Replace getting-started overview diagram with README's proven layout Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.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
1 participant
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
docs/from 10 fragmented docs per language into 3 consolidated docs followingtriton-cpu/docs/riscv64structuredocs/README.mdbilingual index with Quick Links tableREADME.mdandREADME.zh.mdDocumentation sectionsTest plan
docs/en/anddocs/zh/each contain exactly 3 filesdocs/README.mdhas bilingual Quick Links table