convert code bloc examples to rich-codex where possible
Open
Nobody has claimed this yet.
documentation
first-timers-only
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Similar to how it is done here https://github.com/nf-core/nf-co.re/blob/518d3d5e8edb2a5a85da1f1e1d920a3e1940818f/.github/rich-codex.yml (which are then manually embed in the markdown files)
Contributor guide
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 referenced .github/rich-codex.yml example and the website's existing markdown files with code blocks. Identify which examples can use rich-codex, then manually embed the generated results in the relevant markdown files. Done means the applicable code block examples have been converted without changing examples that rich-codex cannot support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100