haskell / haskell/haskell-language-server

Convert markdown documentation to reStructuredText

Open
#3,663 1 comment 1 reaction 0 assignees View on GitHub
documentation type: enhancement
Dominant language
Haskell
Stars
3k
Forks
455
Avg merge
3d 21h
Merged PRs (30d)
13

Description

## Motivation

Markdown is great but lacks some interesting features:
- Importing source code with `literalInclude`
- Admonition boxes
- etc.

## Proposed solution
Ideally all markdown files in the `docs/` directory could be converted to reStructuredText.

## Additional context
This issue originated from a [comment](https://github.com/haskell/haskell-language-server/pull/3655#discussion_r1229835773).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the Markdown files under docs/ and read the originating discussion in pull request 3655. Review the documentation setup to understand how reStructuredText is expected to be used. Done means all applicable Markdown files in docs/ have been converted while preserving their content and enabling the proposed literalInclude and admonition features.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.