Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The documentation should be distributed together with the binaries #1395

Closed
sjakobi opened this issue Nov 21, 2015 · 3 comments
Closed

The documentation should be distributed together with the binaries #1395

sjakobi opened this issue Nov 21, 2015 · 3 comments

Comments

@sjakobi
Copy link
Member

sjakobi commented Nov 21, 2015

(Continuing from #1374)

As stack gains ever more commands, flags and options, it would be really handy to have html- and pdf-versions of doc/*.md locally installed together with the stack binary.

Current error messages like

You can try again, or create your stack.yaml file by hand. See:

    https://github.com/commercialhaskell/stack/blob/release/doc/yaml_configuration.md

(after a failed stack init)
could instead be

You can try again, or create your stack.yaml file by hand. For more info, run

    stack doc yaml_configuration

stack doc <topic> then opens the relevant html or pdf page (with the --pdf flag).

@borsboom
Copy link
Contributor

Yeah, that seems like a good idea. We should embed the docs into the executable using file-embed. Since the docs are Markdown, they could potentially also be displayed using a pager (e.g. less) as well; in fact, there's already some unused code in the repo for running a pager (no idea if it works on Windows, though, but it might).

@yamadapc
Copy link
Contributor

I'd say help is a nicer name for this command.

@mpilgrem
Copy link
Member

I am going to close this because (a) the lack of activity and (b) modern terminal software detects URLs and automatically presents them as clickable links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants