Stream: ideas

Topic: Platform author starter pack

Erwin Kuhn (Dec 09 2021 at 11:33):

Proposal: a fully documented and commented template for writing a platform. This would include explanations on how to build and execute effects, how to structure your code, and delimitations around the necessary compiler boilerplate. The goal would be that you can just clone / copy the code and start writing your own effects :working_on_it:

Reasoning: I see 2 main reasons why making platform authoring more accessible would be good

• Platforms are one of Roc's most unique features and early adopters are likely to be interested in them
• Any more advanced program will likely want additional effects, beyond the basic ones provided in the examples. This would make it easier to build your own infrastructure and start doing more things with Roc.

Possible counterargument: the platform interface is still very unstable and is likely to change in the future, so it's not yet the right time to make it more accessible. But to be fair, people here know what they're signing up for, right?

I'd be interested in writing that kind of template :hand:, so I wanted to check in with you on the relevance of such an example as part of the main documentation!

Anton (Dec 09 2021 at 11:37):

Excellent idea @Erwin Kuhn :+1: We can add a CI test for this template platform so we're immediately aware of any breaking changes.

Richard Feldman (Dec 09 2021 at 14:45):

yeah, love it! :100:

Erwin Kuhn (Dec 09 2021 at 14:53):

Alright, I'll start playing around with it while I continue on Advent of Code. I'll probably have some questions over the next few days :grinning_face_with_smiling_eyes:

Lucas Rosa (Dec 09 2021 at 19:37):

Nothing wrong with having it started but I would also expect it to need to be changed eventually. Good initiative

Last updated: Jun 16 2026 at 16:19 UTC