Skip to content

Revamp docs site on distributed process #357

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

Open
joelmccracken opened this issue Oct 22, 2021 · 2 comments
Open

Revamp docs site on distributed process #357

joelmccracken opened this issue Oct 22, 2021 · 2 comments

Comments

@joelmccracken
Copy link
Member

No description provided.

@tmcgilchrist
Copy link
Contributor

Do you have a preference for what the new site uses or looks like? I've used GatsbyJS for these sort of sites before, which is not Haskell but works fine. You write the content in markdown files and you can include code sections into the markdown.

As part of this, it would be useful to have a corpus of examples for distributed-process that are kept up to date. I'm often writing small sample apps or copying the Haddock sample code into files to test it out. Keeping them alongside the distributed-process repo would convenient. Do you have a preference for this?

cc @LaurentRDC

@LaurentRDC
Copy link
Member

There are many suitable static site generators.

I would suggest any static site generator that can use Pandoc. The reason is that Pandoc supports Literate Haskell as input, such that the body of a page can both be a valid Haskell module, AND a webpage. I use this myself (e.g. this blog post is a Literate Haskell file) in combination with hakyll, which a static site generator build with Haskell and used throughout the ecosystem.

I think the current site uses Jekyll, which is another popular choice that plays very well with Github pages.

Beyond this, whoever wants to put in the work gets to make the work as easy for them as they want!

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

No branches or pull requests

3 participants