dhall-haskell icon indicating copy to clipboard operation
dhall-haskell copied to clipboard

Ideas to make `dhall-docs` more easy to discover

Open german1608 opened this issue 5 years ago • 2 comments

Today I found this comment on the #dhall channel at functional programming slack's workspace:

https://functionalprogramming.slack.com/archives/C82N1L0MB/p1600199375075200?thread_ts=1600157283.069200&cid=C82N1L0MB

What can we do to make dhall-docs easier to discover? I'm thinking of:

  • Adding an entry to docs.dhall-lang.org or dhall-lang.org
  • We could add a reference to the tool in the generated HTML, similar to haddock's generated footers (see the footer of this example)

german1608 avatar Sep 16 '20 00:09 german1608

In the README page of dhall-kubernetes a link to the generated dhall docs would be one easy way to draw attention.

PierreR avatar Sep 16 '20 07:09 PierreR

I think the first step is deciding what subdomain of dhall-lang.org to use (since docs.dhall-lang.org is already taken). Then we could start hosting documentation for a few selected packages (e.g. the Prelude and dhall-kubernetes) underneath there until we have something more systematic.

Gabriella439 avatar Sep 19 '20 23:09 Gabriella439