Improving Documentation - VideoChat

Welcome to the Functional Programming Zulip Chat Archive. You can join the chat here.

Sridhar Ratnakumar

contd. from https://funprog.zulipchat.com/#narrow/stream/234801-VideoChat/topic/General/near/196029757

As far as documentation is concerned, that's a main goal behind https://haskell.zettel.page/ - but right now it is just me writing to it sporadically. But it'd be great to have others (I can give direct commit access to master which gets deployed instantly). Just send me your GitHub user name and I'll add you.

Hazem

Wow it really grew in content since it was announced! Great job

Hazem

I might be able to contribute some content soon-ish. I'll contact you when ready
Edit: soon -> soon-ish :P

gilmi

I have a bunch of content I can add if you want. My github user is soupi.

gilmi

Or I'll just send PRs.

Bolt

Regarding documentation there's already an effort to improve the base docs! See https://www.reddit.com/r/haskell/comments/fke5tf/announce_tracking_the_documentation_effort_for/

gilmi

@Sridhar Ratnakumar I'll need a little guidance on how to work on this. I tried installing neuron using the installation steps but it fails with:

error: getting attributes of path '/nix/store/9krlzvny65gdc8s7kpb6lkx8cd02c25b-default-builder.sh': No such file or directory
Sridhar Ratnakumar

I'll PM you. That's an error I've never seen.

gilmi

I've made a PR with some additions.

Sridhar Ratnakumar

I've merged it. Feel free to push directly to master. The site will update within 60 seconds of pushing to remote.

Vance Palacio

@Sridhar Ratnakumar continuing here - regarding my own website/blog, currently I don't have one yet. I'm not sure if gitlab has something similar to "GitHub pages" but if so, I could use that to build something up. (I've been thinking about that anyhow)

Sridhar Ratnakumar

There is Gitlab pages, yes. What do you think of building a site like mine (srid.ca)? It is built using neuron, the same tool behind the Haskell zettelksaten.

Welcome to the personal home page of Sridhar Ratnakumar, a passionate Haskeller and an actualist. I work as a Haskell consultant (see résumé).
Vance Palacio

Ah yea maybe so - I'll have to read through the tutorial and familiarize myself with it

Sridhar Ratnakumar

@Vance Palacio neuron is fairly easy to install and use. If you use emacs (doom-emacs), even better. I can pair with you if you like (using tmate.io) to set things up

Sridhar Ratnakumar

... that gives me an idea: I should write a tutorial on it!

Vance Palacio

Ah ok cool! I think I'll be ok, I'll try my hand at it first and let you know if I hit any major blockers. Thanks!

Sridhar Ratnakumar

I think there is a real opportunity to write about the 'three layer cake' pattern. The original blog post is not enough. I just stumbled across the "Has" pattern, https://github.com/Holmusk/three-layer/blob/master/src/Lib/App/Env.hs

:three: :cake: Architecture of the Haskell web applications - Holmusk/three-layer
Sridhar Ratnakumar

Basically describe the various patterns in the Holmus/three-layer app. Nice idea for a cluster of zettels to add ...

Sridhar Ratnakumar

Would anyone like to contribute to summarizing the current state of IDE support in Haskell? What I have right now: https://haskell.zettel.page/58bc09d0.html

Reed Mullanix

Just wanted to say that Neuron is looking super slick!