JuliaHealth / JuliaHealth/HealthSampleData.jl
[FEATURE] Add Documenter Support
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Currently, documenter.jl is not integrated yet with this repository! We need to fix this by using https://documenter.juliadocs.org/stable/ and https://github.com/JuliaDocs/DocumenterTools.jl. Should be a relatively straightforward process and the docs folder for omopcdmcohortcreator.jl could be a great skeleton to copy from for this issue: https://github.com/JuliaHealth/OMOPCDMCohortCreator.jl/tree/main/docs
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 reading the Documenter.jl and DocumenterTools.jl guides, then inspect the docs folder in OMOPCDMCohortCreator.jl as the proposed skeleton. Adapt that structure for HealthSampleData.jl and verify that the repository’s documentation builds successfully with Documenter support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100