Skip to content

Update installation script path in documentation to monorepo#160

Merged
bennyz merged 1 commit intomainfrom
monorepo-paths-install
Jan 27, 2026
Merged

Update installation script path in documentation to monorepo#160
bennyz merged 1 commit intomainfrom
monorepo-paths-install

Conversation

@mangelajo
Copy link
Copy Markdown
Member

@mangelajo mangelajo commented Jan 27, 2026

Summary by CodeRabbit

  • Documentation
    • Updated Python package installation instructions to reference the Python-specific installation script for accurate setup guidance.
    • Fixed documentation file formatting.

✏️ Tip: You can customize this high-level summary in your review settings.

@mangelajo mangelajo requested a review from bkhizgiy January 27, 2026 08:46
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 27, 2026

📝 Walkthrough

Walkthrough

Documentation file updated to redirect installation instructions from the root install script to the Python-specific install script location. Two URL references modified and file formatting corrected.

Changes

Cohort / File(s) Summary
Installation Documentation
python/docs/source/getting-started/installation/packages.md
Updated Quick Install and explicit source specification code blocks to reference python/install.sh instead of root-level install.sh. Added newline at end of file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A script path redirect, so small yet so fine,
Python's own install now gets its own line,
From root to the python folder it hops,
Documentation corrected, the fix never stops! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: updating installation script paths in documentation from a root-level script to a Python-specific script within the monorepo structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
python/docs/source/getting-started/installation/packages.md (1)

35-45: Update local install commands to match the new script path.

The remote installer URL now points to python/install.sh, but the local install table still uses ./install.sh. If the root script no longer exists, these commands will fail for a cloned repo. Please update the local commands (or clarify that a root install.sh remains).

@bennyz bennyz merged commit 5489b79 into main Jan 27, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants