Bad index in hackage documentation for `lsp-types`?
- Dominant language
- Haskell
- Stars
- 423
- Forks
- 105
- PR merge metrics
- No merged PRs in 30d
Description
There appears to be something wrong with the hackage docs of `lsp-types`, in particular:
* If you open `Language.LSP.Protoco.Message` and press `ctrs-S` to search for names, typing `Method` says that there is no such name. However, if you just use the ordinary "find in page" capability of the browser, the definition of `Method` is clearly there.
* If you click on the `index` link for `lsp-types` you get an empty page.
* When you browse the docs for `lsp`, (e.g., `Language.LSP.Server`), a bunch of the types that come from `lsp-types` are not hyperlinked (e.g., `NormalizedUri`, `Method`, `ClientToServer`, etc).
Contributor guide
Research direction
Start by reproducing the hackage documentation problems for lsp-types and lsp: search for Method in Language.LSP.Protoco.Message, open the lsp-types index, and inspect links for NormalizedUri, Method, and ClientToServer from Language.LSP.Server. Done means the index is populated, search finds the documented names, and types from lsp-types are hyperlinked in the lsp documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100