CDCgov / CDCgov/PyRenew

Migrate docs to Zensical

Open
#750 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
29
Forks
9
Avg merge
9d 9h
Merged PRs (30d)
8

Description

When we do this, we should also switch to MathJAX based math rendering (with fallback to vanilla MathML). Would be great to be able to get something like the setup here https://scoringrules.readthedocs.io/en/latest/theory.html

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

Start by locating the repository's current documentation configuration and rendered documentation entry point. Review the setup linked from scoringrules.readthedocs.io, then determine the migration scope and how MathJAX with vanilla MathML fallback should be configured. Done means the documentation builds with Zensical and renders mathematical content through the requested fallback setup.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.