Auto-link to params to their definitions
Open
Nobody has claimed this yet.
automation
enhancement
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
While parsing usage.md and while rendering the pipeline schema (and probably output.md), softlinks should be added wherever a parameter is mentioned, linking to their definitions in the parameters section on /usage.
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 examining usage.md and the code that renders the pipeline schema; output.md may also need the same treatment. Trace how parameter mentions and the parameters section on /usage are generated. Done means parameter mentions in those outputs link to their definitions wherever applicable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100