developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Update segments.md

Open bojana-z opened this issue 1 year ago • 4 comments

Added sentence for segment value encoding

Description:

Please include a description of this change and which issue it fixes. If no issue exists yet please include context and what problem it solves.

Review

bojana-z avatar Apr 08 '24 02:04 bojana-z

@bojana-z what is the reason for adding that? That page actually starts with This guide applies to core developers., so it should be clear this is not meant for normal users. Or were there any confusions?

sgiehl avatar Apr 08 '24 09:04 sgiehl

@sgiehl there was some confusion with a customer. Matthieu suggested adding it to prevent similar support requests in the future.

bojana-z avatar Apr 08 '24 10:04 bojana-z

Ah ok. Well I'm not sure if it might not make more sense to have a general message being displayed on all pages that they are viewing the developer docs, which are not meant to be used by normal users. Otherwise we might end up adding such a note to all pages over time...

sgiehl avatar Apr 08 '24 11:04 sgiehl

I think that's a good idea.

bojana-z avatar Apr 09 '24 08:04 bojana-z