Document the Velocity plugin JSON file format
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
The annotation processor, which is currently recommended to be used, is not exactly the nicest to use for anything slightly more dynamic (since variable substitution is hard). For this reason, we should document the Velocity plugin JSON file in order to make the manual inclusion possible.
I also think we should remove (or at least inline) any mentions of the AP for generating that file and instead make manually writing the file the preferred way.
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 locating the documentation pages that describe the Velocity plugin JSON file and references to the annotation processor. Document the file format well enough to support manual inclusion, and revise or inline guidance so manual authoring is preferred; the issue is done when both parts are reflected consistently in the docs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100