Add "How It Works" section to README
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Lua
- Stars
- 22
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Explain the underlying process so that users know what is happening to the buffer.
Perhaps point to clear explanation of bidi text as well.
Contributor guide
No contributing guide indexed for this repository
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
Update the README with a “How It Works” section explaining what happens to the buffer during bidi.nvim processing. Start by reading the existing README and the plugin’s user-facing description, then add a clear explanation and a link to an accessible overview of bidirectional text. Done means users can understand the underlying process from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100