Skip to content

fix(docs): forest install instruction#6464

Merged
LesnyRumcajs merged 1 commit intomainfrom
fix-readme-instruction
Jan 22, 2026
Merged

fix(docs): forest install instruction#6464
LesnyRumcajs merged 1 commit intomainfrom
fix-readme-instruction

Conversation

@LesnyRumcajs
Copy link
Copy Markdown
Member

@LesnyRumcajs LesnyRumcajs commented Jan 22, 2026

Summary of changes

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Documentation
    • Updated installation and setup commands across multiple deployment variants (quick, release-lto-fat, dev, and slim options) to reflect updated execution method
    • Added build example demonstrating faster compilation times with new profile capability
    • Installation instructions now reflect consistent command syntax

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

@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner January 22, 2026 13:42
@LesnyRumcajs LesnyRumcajs requested review from akaladarshi and hanabi1224 and removed request for a team January 22, 2026 13:42
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 22, 2026

Walkthrough

This PR updates installation command references in documentation files from "mise install" to "mise run install" across AGENTS.md and README.md, and adds a cargo build profile example. These changes modify the execution path for binary installation during setup without altering control flow or error handling.

Changes

Cohort / File(s) Summary
Documentation command updates
AGENTS.md, README.md
Updated "mise install" commands to "mise run install" across quick, release-lto-fat, dev, and --slim build variants; added "cargo build --profile quick" example line

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • fix: docs linting #6452: Both PRs update usage of "mise run" command in documentation and workflows to standardize task execution.

Suggested reviewers

  • hanabi1224
  • akaladarshi
🚥 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 describes the main change—updating installation instructions in documentation files (AGENTS.md and README.md) by modifying CLI commands from 'mise install' to 'mise run install'.
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.


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

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.69%. Comparing base (fbf52a1) to head (5b03ca7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

see 7 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fbf52a1...5b03ca7. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Jan 22, 2026
Merged via the queue into main with commit 1546c7c Jan 22, 2026
43 checks passed
@LesnyRumcajs LesnyRumcajs deleted the fix-readme-instruction branch January 22, 2026 15:06
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.

2 participants