ianmackenzie / ianmackenzie/opensolid
PoC conversion of rich text from Haskell doc comments to target languages
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 18
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Could try using Pandoc to convert from Haddock markup to e.g. ReStructuredText for Python, but seems most robust to parse the Haddock comments using the official Haddock library and then directly generate markup for target languages.
Basic markup elements to try to support:
- Bold and italic
- Bulleted lists
Trickier (but most useful!) will be to support references to functions/types, since this will involve mapping from Haskell names to target language names. (Type names should be the same in all languages, but function names will need conversion from camel case to snake case or Pascal case.)
Contributor guide
No contributing guide indexed for this repository
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
No repository files or tests are named. Start by evaluating the official Haddock library and Pandoc options for parsing Haddock comments, then define a small proof of concept covering bold, italic, bulleted lists, and references with target-language name mapping. Done means a working conversion demonstration for the selected elements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100