Skip to content

Conversation

@miparnisari
Copy link
Contributor

@miparnisari miparnisari commented Dec 13, 2025

Description

Updated examples as follows:

  • removed fluff in readmes
  • added comments
  • made schemas readable from top to bottom
  • standardized the "resource" being protected to document (where it made sense)

Testing

zed validate on each YAML

@miparnisari miparnisari force-pushed the update-examples branch 7 times, most recently from 223d43a to 82f6450 Compare December 16, 2025 02:07
@miparnisari miparnisari marked this pull request as ready for review December 16, 2025 02:08
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, see comment

definition user {}
```
Access is granted to all resources of a specific type to a super-admin user.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to put a warning on this one - it's a pattern that folks reach for relatively frequently and then they get confused when LRs blow up on them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll do that on a follow-up PR 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, i don't know if i want to put a warning here... this is a learning ground, will that warning scare people off?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd argue that's the place to put it 🤔 Unless you mean you're worried that someone will look at this and say "oh spicedb can't do this thing?"

Copy link
Contributor Author

@miparnisari miparnisari Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you're looking at this example because you're just looking at the repo, i'd be okay with the warning. but this repo is also shown in the playground. in this case i don't want to show a warning

if the playground didn't source the examples from this repo, then we could solve this..

@miparnisari miparnisari merged commit b17f5c8 into main Dec 17, 2025
7 checks passed
@miparnisari miparnisari deleted the update-examples branch December 17, 2025 21:07
@github-actions github-actions bot locked and limited conversation to collaborators Dec 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants