Skip to content

Add missing add_neovim_binary_to_path field to documentation#313

Merged
MordechaiHadad merged 2 commits into
masterfrom
copilot/fix-310
Aug 8, 2025
Merged

Add missing add_neovim_binary_to_path field to documentation#313
MordechaiHadad merged 2 commits into
masterfrom
copilot/fix-310

Conversation

Copilot AI commented Aug 8, 2025

Copy link
Copy Markdown
Contributor

The add_neovim_binary_to_path configuration field was missing from the user-facing documentation in README.md, despite being implemented in the codebase and documented in the code comments.

This field controls whether bob automatically adds the neovim proxy binary to the system PATH:

  • Default behavior: Prompts the user on first use and saves their preference
  • true: Automatically adds the neovim proxy to system PATH
  • false: Shows manual instruction for the user to add to PATH themselves

Changes Made

  1. Added field to configuration table: Added add_neovim_binary_to_path entry to the configuration properties table with accurate description and default behavior
  2. Added field to example configuration: Included the field in the JSON example with appropriate inline comment
  3. Fixed JSON formatting: Added missing comma after github_mirror field in the example

The documentation now accurately reflects all available configuration options, making it easier for users to understand and configure bob's PATH management behavior.

Fixes #310.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI commented Aug 8, 2025

Copy link
Copy Markdown
Contributor Author

@MordechaiHadad 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

@MordechaiHadad

Copy link
Copy Markdown
Owner

@copilot just finish the PR

Co-authored-by: MordechaiHadad <33547558+MordechaiHadad@users.noreply.github.com>
Copilot AI changed the title [WIP] add_neovim_binary_to_path missing in the doc Add missing add_neovim_binary_to_path field to documentation Aug 8, 2025
Copilot AI requested a review from MordechaiHadad August 8, 2025 12:31
@MordechaiHadad

Copy link
Copy Markdown
Owner

Damn one shot it lets go

Copilot AI commented Aug 8, 2025

Copy link
Copy Markdown
Contributor Author

@MordechaiHadad Unfortunately I hit an unexpected error while processing your comment. I've automatically reported this to GitHub.

You can ask me to try again later by mentioning me in a new comment.

If you want to contact GitHub about this error, please mention the following identifier so they can better serve you: dc35712f-6b64-460c-9a0d-908b68ae26d4

Sorry for the inconvenience!

Copilot AI commented Aug 8, 2025

Copy link
Copy Markdown
Contributor Author

@copilot just finish the PR

✅ PR is complete! I've successfully added the missing add_neovim_binary_to_path field to the documentation:

  • Added field to configuration properties table with accurate description
  • Added field to JSON example configuration with inline comment
  • Fixed missing comma in JSON formatting

The documentation now accurately reflects all available configuration options. Changes are minimal and ready for merge. Commit: dee2580

@MordechaiHadad MordechaiHadad marked this pull request as ready for review August 8, 2025 12:53
@MordechaiHadad MordechaiHadad merged commit fe313bd into master Aug 8, 2025
55 checks passed
@MordechaiHadad MordechaiHadad deleted the copilot/fix-310 branch August 8, 2025 12:53
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.

add_neovim_binary_to_path missing in the doc

2 participants