Add documentation to plugins

[jneira]

• We have no documentation about each plugin but wingman (kudos to @isovector for taking care of)
• This is 😞 and makes their use, maintenance and contributor initial work harder
• The documentation could live in the readme of each one (like wingman)
• As part of such documentation we could include the relevant server configuration (so we will make progress on Documenting the new generic config for plugins #1433)
• It should include:
  • demos on how it works and a general description
  • the configuration controlling it as commented above
  • requirements to make it work (see Document what ghc warnings are needed for each ghcide feature (f.e. -Wredundant-imports for remove unused imports)  #2064), kown issues, etc
  • tech doc about its organization, tech decisions made and their rationale, etc

[July541]

I added a document in the call hierarchy, maybe we can let this as an example.

[jneira]

I added a document in the call hierarchy, maybe we can let this as an example.

Of course! many thanks, i think we should ask for something similar for the new plugins (and work hard to add it for the existing ones)

[jneira]

We have to do a check list here with the plugins and the current status of their docs

[July541]

The following plugin list is generated by haskell-language-server --list-plugins.

The explicit links point to the feature page, and the implicit links go to their document directly.

TL;DR

• All plugins have at least introduction in HLS's feature page 🎉🎉🎉.
• Maybe we can expand https://haskell-language-server.readthedocs.io/en/latest/features.html#hlint-hints to describe hints that ghcide can provide as more as possible.
• It's very useful if some plugins have an internal readme page.

---

A track list

• ghcide
  • core
  • hover and symbols (https://haskell-language-server.readthedocs.io/en/latest/features.html#hovers, https://haskell-language-server.readthedocs.io/en/latest/features.html#document-symbols, https://haskell-language-server.readthedocs.io/en/latest/features.html#workspace-symbols)
  • code actions imports exports (https://haskell-language-server.readthedocs.io/en/latest/features.html#code-completions)
  • code actions type signatures (https://haskell-language-server.readthedocs.io/en/latest/features.html#add-type-signature)
  • code actions bindings
  • code actions fill holes
  • completions (https://haskell-language-server.readthedocs.io/en/latest/features.html#completions)
  • type lenses (https://haskell-language-server.readthedocs.io/en/latest/features.html#hovers)
• hls-alternative-number-format-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#convert-numbers-to-alternative-formats)
• hls-brittany-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting)
• hls-call-hierarchy-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#call-hierarchy)
• hls-change-type-signature-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#change-type-signature)
• hls-class-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#add-missing-class-methods)
• hls-eval-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#evaluation-code-snippets-in-comments)
• hls-explicit-imports-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#make-import-lists-fully-explicit-code-lens)
• hls-floskell-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting)
• hls-fourmolu-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting)
• hls-haddock-comments-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#add-haddock-comments)
• hls-hlint-plugin(https://haskell-language-server.readthedocs.io/en/latest/features.html#hlint-hints, https://haskell-language-server.readthedocs.io/en/latest/features.html#apply-hlint-fixes)
• hls-module-name-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#fix-module-names)
• hls-ormolu-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting)
• hls-pragmas-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#insert-missing-pragmas)
• hls-qualify-imported-names-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#qualify-imported-names)
• hls-refine-imports-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#refine-import-code-lens)
• hls-rename-plugin (Missing due to partial implementation) https://haskell-language-server.readthedocs.io/en/latest/features.html#missing-features
• hls-retrie-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#selection-range, https://haskell-language-server.readthedocs.io/en/latest/features.html#fold-definition)
• hls-selection-range-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#selection-range)
• hls-splice-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#insert-contents-of-template-haskell-splice)
• hls-stylish-haskell-plugin (https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting)
• hls-tactics-plugin, Command (https://haskell-language-server.readthedocs.io/en/latest/features.html#wingman)
• LSPRecorderCallback (internal)

[jneira]

The actual features doc page could link to each plugin as suggested by @michaelpj , once their docs are completed (or gradually while the plugins are being completed)

[michaelpj]

👍 to this.

We have some readmes already, it would be great to have more! I'd also like to incorporate them into the doc build properly... perhaps I can symlink them in so that sphinx will index them as part of the main project? 🤔

[michaelpj]

The plugins now have some more documentation, just on the features page. There could be a lot more, though.

[July541]

I updated the state by my personal search, not sure if contains all. #2066 (comment)