[Doc] Update doc, add troubleshooting section#1485
[Doc] Update doc, add troubleshooting section#1485oraluben wants to merge 2 commits intotile-ai:mainfrom
Conversation
WalkthroughStreamlined README.md installation section to a single quick-install command with link to advanced guide. Expanded docs/get_started/Installation.md with Docker installation, nightly builds, and reorganized guidance sections, removing duplicate content. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Documentation-only changes with no code logic to verify. Straightforward content consolidation and reorganization with no functional alterations. Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
👋 Hi! Thank you for contributing to the TileLang project. Please remember to run We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/get_started/Installation.md (1)
52-52: Minor grammar refinement needed.Line 52 reads "use that built image on other machine" but should be "on another machine" for grammatical correctness.
🔎 Proposed fix
- **NVIDIA Docker runtime or GPU is not necessary for building tilelang, you can build on a host without GPU and use that built image on other machine. + **NVIDIA Docker runtime or GPU is not necessary for building tilelang, you can build on a host without GPU and use that built image on another machine.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)docs/get_started/Installation.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/get_started/Installation.md
[grammar] ~52-~52: Ensure spelling is correct
Context: ...without GPU and use that built image on other machine. 1. Clone the Repository: ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test for Python 3.12 with Metal (on macos-latest)
- GitHub Check: Test for Python 3.12 with Nightly-ROCm-7.1 (on self-hosted-amd)
🔇 Additional comments (4)
README.md (1)
85-98: Excellent simplification of the installation section.The streamlined quick-install approach with a clear reference to the detailed Installation Guide is a great UX improvement. New users get a fast path to installation, while advanced users can easily find nightly builds, source builds, and Docker options.
docs/get_started/Installation.md (3)
35-45: Nightly installation section is clear and appropriately cautious.The section provides a straightforward install command and includes a helpful stability note to set user expectations. The dual command format (with and without
--find-links) provides flexibility.
46-101: Well-organized Docker installation with comprehensive guidance.The step-by-step structure is clear, the parameter explanations are valuable, and the verification step ensures users confirm successful setup. This is a significant improvement for users who prefer containerized environments.
238-270: Troubleshooting section effectively addresses the Z3 dependency issue.The explanation clearly contextualizes the problem (build isolation in
uvenvironments), explains the root cause (incompatiblelibz3), and provides a straightforward solution. This directly fulfills the PR's objective to inform users about the Z3 installation issue and the--no-build-isolationworkaround.
The purpose of this PR is to inform user that install with
uv pipand without--no-build-isolationmight cause runtime issue about z3:This PR also refactor a lot about install instructions, move most of them into
Installation.md.