Skip to content

Improve manual (and README) #702

Closed
Closed
@geraldus

Description

@geraldus

I think we need to improve current documentation. User should have prominently displayed comprehensive brief overview of all major features of haskell mode somewhere , there should be covered following issues:

  • Minimal setup: how to get and what features it gives
  • Interactive and Inferior modes should be mentioned right after that, there should be short description (explaining what is the difference between them?) followed by further instructions links for both.
  • Auto-completions and how to improve them
  • Each section should mention all optional external tools that could improve user experience (e.g. hasktags, stylish-haskell, hoogle)
    I think we need to mention `(add-hook 'haskell-mode-hook …) at least.
  • Replace link the online haskell-mode manual to HTML manual page in README's Advanced configuration section.

What else?

It would be great to have a native English volunteer for documentation updates.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions