AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

recommonmark is archived and no longer supported

Open
#2,334 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2.1k
Forks
503
PR merge metrics
No merged PRs in 30d

Description

recommonmark is no longer [supported,](https://github.com/readthedocs/recommonmark/issues/221) and [myst-parser](https://pypi.org/project/myst-parser/) is the recommended way forward. I'm happy to work on this with a PR, but I also wanted to start with an issue before pushing up a massive change converting everything from ReST to Markdown.

Contributor guide

Open the contributing guide

Research direction

Begin by reviewing the documentation build configuration and current ReST content to inventory the migration. Replace the archived recommonmark path with myst-parser and convert the project's documentation to Markdown; done means the documentation builds successfully without recommonmark.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.