nvim-tree / nvim-tree/nvim-tree.lua
:help nvim-tree-root-and-cwd
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 8.6k
- Forks
- 639
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
tree.open, tree.toggle, tree.find_file and update focused file behaviour has many scattered options to control their behaviour.
Add a help section to outline all these options and API parameters and how they relate to each other.
Also cover actions.change_dir, sync_root_with_cwd, prefer_startup_root, respect_buf_cwd
See https://github.com/nvim-tree/nvim-tree.lua/discussions/2062#discussion-4981774
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing help documentation and the behavior of tree.open, tree.toggle, tree.find_file, and the focused-file update options. Trace how actions.change_dir, sync_root_with_cwd, prefer_startup_root, and respect_buf_cwd relate to those APIs. Done means a help section clearly explains all named options and parameters and how they interact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100