Skip to content

Fix link formatting in README.md#487

Merged
bl-ue merged 2 commits intoPiebald-AI:mainfrom
brrock:patch-1
Feb 7, 2026
Merged

Fix link formatting in README.md#487
bl-ue merged 2 commits intoPiebald-AI:mainfrom
brrock:patch-1

Conversation

@brrock
Copy link
Copy Markdown
Contributor

@brrock brrock commented Feb 7, 2026

Summary by CodeRabbit

  • Documentation

    • Fixed link anchor formatting and reworded the installer warning to clarify it appears when using npm.
    • Updated UI/config guidance to use the new public option name in examples.
  • New Features

    • Added a new public configuration flag: suppressNativeInstallerWarning (boolean) to disable the native-installer suggestion.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 7, 2026

📝 Walkthrough

Walkthrough

Updated wording and link formatting for the "Suppress native installer warning" feature in the README and added a new public configuration option exposed as settings.misc.suppressNativeInstallerWarning: boolean. UI/config example and feature description were adjusted to reflect npm-based detection for advising native installer usage.

Changes

Cohort / File(s) Summary
Documentation
README.md
Changed anchor link formatting for "Suppress native installer warning"; reworded feature description to indicate npm installation is the trigger; updated UI/config example to reference the new public option name.
Configuration / UI examples
config/type/..., config/defaults/..., ui/...
Added new public config property settings.misc.suppressNativeInstallerWarning (boolean) and updated example wiring/usages in config/UI examples.
Manifest / ancillary
manifest
Minor line edits reflected (+2/-3) consistent with the added public config declaration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • bl-ue

Poem

🐰 I nibbled docs and toggled a flag,
A gentle change, no need to brag.
"Suppress the warning," I softly sing—
A tiny hop for the config string. 🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'Fix link formatting in README.md' only addresses one minor aspect of the changeset (fixing TOC link formatting), but does not reflect the main changes: reworded feature descriptions, new configuration options, and updated UI/config instructions. Revise the title to reflect the primary changes, such as 'Add suppressNativeInstallerWarning config option and update README documentation' or 'Update native installer warning feature and add configuration option'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉


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.

@brrock brrock marked this pull request as draft February 7, 2026 17:25
@brrock brrock marked this pull request as ready for review February 7, 2026 17:29
@bl-ue bl-ue enabled auto-merge (squash) February 7, 2026 18:06
@bl-ue bl-ue merged commit 0029a6d into Piebald-AI:main Feb 7, 2026
2 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.

2 participants