nickjvandyke / nickjvandyke/opencode.nvim

feature: doc/opencode.txt

Open
#41 1 comment 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Lua
Stars
3.8k
Forks
161
Avg merge
13h 14m
Merged PRs (30d)
5

Description

Did you check the docs?
  • I have read all the docs
Is your feature request related to a problem? Please describe.

Missing doc/opencode.txt file so I can't use :help in Nvim.

Describe the solution you'd like

Provide doc/opencode.txt as the main source of documentation.

Describe alternatives you've considered

Reading the readme, which (currently) is not supported by :help.

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the README as the source material and inspect Neovim's :help documentation conventions before creating doc/opencode.txt. Confirm that the file presents the project's main documentation and can be discovered through :help, with the README information represented in the help format.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, neovim
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.