Stream: ideas

Topic: FAQ Website


view this post on Zulip Luke Boswell (Mar 10 2023 at 21:35):

What do people think about moving FAQ, Contributing, Roc for Elm Programmers into the website as opposed to just a markdown file on Github? I'm not necessarily thinking moving anything or everything all in one go, but as an eventual home. The main benefit I think would be presentation using Roc's style. One possible downside is that it wont be in the root folder of the repo, but maybe you could still have a file that links to the site. Maybe there is a way to use static site to pull in the markdown from root, but I was thinking more about what could be on the Roc website eventually. It may be helpful to describe a user story for a newcomer or something to really step through the experience. I know the home page is deliberately styled basic, but would it be helpful to start building out more of the supporting content and putting it together in an organised way?

view this post on Zulip Wolfgang Schuster (Mar 10 2023 at 21:37):

You could use elm-pages v3 to pull it directly from GitHub so that it's always up to date with what's in the main branch

view this post on Zulip Luke Boswell (Mar 10 2023 at 21:43):

That could work. Maybe we can upgrade roc's static-site platform to do something similar? Now that we've got syntax highlighting it made me think of it when reading through the FAQ and seeing all the code snippets.

view this post on Zulip Richard Feldman (Mar 10 2023 at 22:04):

yeah I like the idea of moving at least FAQ and Roc for Elm Programmers over

view this post on Zulip Richard Feldman (Mar 10 2023 at 22:04):

Contributing feels like it should stay as a markdown file in the repo to me

view this post on Zulip Richard Feldman (Mar 10 2023 at 22:04):

that's where it typically can be found

view this post on Zulip Brendan Hansknecht (Dec 11 2023 at 18:58):

Just gonna ping this topic. Would be really nice if we got the FAQ onto the actual website now that the new version of the website is up. Would probably be a good first issue if someone wants to contribute. Just need to add some extra markdown based pages to the site.

FAQ being the most important, Roc for Elm Programmers also being nice to have.

view this post on Zulip Richard Feldman (Dec 11 2023 at 19:00):

good point! do we have an issue for this?

view this post on Zulip Anton (Dec 12 2023 at 09:59):

I did not find an existing issue, so I started making one and then thought about where to put the page...
What do you all think about changing the header from:

tutorial | install | examples | community | docs | donate

To

learn | install | docs | community | donate

And put the tutorial, examples and FAQ as links on the learn page

view this post on Zulip Richard Feldman (Dec 12 2023 at 11:56):

I thought about that, but I prefer having them be separate. I think we can put the FAQ under docs for now

view this post on Zulip Anton (Dec 12 2023 at 12:37):

#6260


Last updated: Jun 16 2026 at 16:19 UTC