Auto-linking to Javadocs
Open
Nobody has claimed this yet.
good first issue
project: Adventure
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
We currently reference a bunch of Adventure classes, which have additional context in the JD. It would be helpful to link directly to those classes with a component/something.
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
The issue concerns references to Adventure classes and links to their Javadocs, but it names no files, tests, or entry points. First locate where Adventure class references are rendered, then determine the intended linking component; done means those references link directly to the relevant Javadoc pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100