ndmitchell / ndmitchell/hoogle

Fix up manual

Open
#130 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
803
Forks
152
PR merge metrics
No merged PRs in 30d

Description

From https://code.google.com/p/ndmitchell/issues/detail?id=468

Currently Hoogle has a wiki for a manual, but it's out of date, since I can't edit it while offline. The manual should be redone, and answer lots of questions, including things like:

http://stackoverflow.com/questions/6989668/how-to-use-hoogle-locally-like-ctags

http://jpmoresmau.blogspot.com/2011/08/hoogle-command-line-on-windows.html

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Hoogle wiki manual and the linked questions about local use, ctags-like workflows, and Windows command-line usage. Determine where the manual content is maintained and define the questions it must answer; done means an updated manual covering those use cases and the offline-editing limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.