lenskit / lenskit/java.lenskit.org
Extract all code examples from testable code
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 3
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
It would be fantastic — but a high bar — to make all code examples in the manual extracted from or insertable into running examples, to verify their correctness.
This would require significant improvements to the web site / docs toolchain.
Contributor guide
No contributing guide indexed for this repository
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 reviewing the manual and the web site/docs toolchain to inventory how code examples are currently authored and rendered. Define a feasible extraction or insertion workflow and verification approach; done means the examples can be checked as running code across the manual.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100