nvim-orgmode / nvim-orgmode/orgmode
Add API documentation
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 3.9k
- Forks
- 190
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Description
Does this feature exist in Emacs orgmode core?
N/A
Orgmode link
No response
Feature value
Enable easier production of plugins for orgmode.nvim.
Additional context
I have been trying my best to create some plugins for org-mode, but it has been a struggle due to (1) not seeing any reference to the API in the current documentation and (2) after finding it, I couldn't grasp my thoughts around it since its vague in description and short for the amount of functionality the plugin gives.
Would gladly help in adding documentation and examples for this if needed since, as of today, the API could be more precise if you don't know the ins and outs of the plugin.
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
No file, test, or entry point is named. Start by locating the current API documentation and reviewing the plugin's exposed API; document the available functionality with precise descriptions and examples so someone unfamiliar with orgmode.nvim can build a plugin without relying on implementation knowledge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100