portal 2023-02-16 | Slack Archive

grahamcarlyle13:02:58

When I was first setting up portal and shadow using the guide I wasn't initially clear that the code required me to create a portal.setup namespace to be referred in the shadow :devtools :preloads config. I wonder if it would be better for the guide to suggest a config using the available portal.shadow.preload namespace as a preload to get started? e.g.

:build-hooks [(portal.shadow.remote/hook)]
:devtools   {:preloads [portal.shadow.preload]}

that way someone can get started quicker and then perhaps switch to a custom preload

djblue20:02:41

Good point, would you like to submit a PR with the proposed change?

grahamcarlyle14:02:18

I've submitted a PR https://github.com/djblue/portal/pull/167

djblue18:02:52

I think I lean more towards clarifying that the user needs to create these namespaces than providing examples from the portal library code. As soon as people can pull it in, it becomes part of the api surface area of portal which I want to keep small.

grahamcarlyle09:02:18

I've reverted those changes in the PR, and tried again with just some updates to the docs. In the guide I defaulted the config to the existing namespace just because that seems the quickest way to get going, and also tweaked the examples to have namespaces that emphasise they aren't part of portal code. Feel free to ignore this though as this is just addressing a small bit of friction I felt.

❤️ 2

djblue16:02:52

Every bit of friction reduced is a win, thanks 🙏

👍 2

2023-02-16

Channels