typelevel / typelevel/typelevel.github.com
Resurrect mdoc
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 42
- Forks
- 115
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 7
Description
Because of the impending Bintraypocalypse I've removed all traces of tut from this repository, by "simply" generating the Markdown files once and for all. The resulting files are then committed to the _posts directory (commit 2df80471075c2ef621ea30c78199f33782fd7d19).
If anyone would like to take a stab at reverting parts of that and switching to mdoc, feel free to. I opened this ticket so that future generations will know what happened on April 14, 2021.
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 committed generated Markdown in _posts and commit 2df80471075c2ef621ea30c78199f33782fd7d19 to understand what was removed. Investigate how the repository could switch back to mdoc; done would mean restoring that generation workflow without relying on the removed tut setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100