JuliaHealth / JuliaHealth/BioMedQuery.jl

Bring back mkdocs for documentation

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Julia
Stars
19
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Documenter default output is niw html. Using mkdocs with material theme requires few extra steps. Do we want to do so?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not identify documentation files, tests, or an entry point. First inspect the repository's current Documenter setup and documentation configuration, then determine the required changes for a Material-themed mkdocs setup; done means the project has an agreed documentation tool and a working generated site.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.