-
Notifications
You must be signed in to change notification settings - Fork 42
SpiceDB: add docs #298
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SpiceDB: add docs #298
Conversation
@kartikaysaxena is attempting to deploy a commit to the Authzed Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How did you create these files? Manually?
If so, could we create a Github workflow that automatically updates this documentation? Similar to https://github.com/authzed/zed/blob/main/.github/workflows/docs.yaml but it would live in the SpiceDB repo.
pages/spicedb/_meta.json
Outdated
@@ -4,5 +4,6 @@ | |||
"modeling": "Modeling & Integrating", | |||
"ops": "Operations", | |||
"api": "API Reference", | |||
"links": "Links" | |||
"links": "Links", | |||
"docs": "CLI Docs" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of creating a new section, please
- Re-use the existing page: https://github.com/authzed/docs/blob/main/pages/spicedb/concepts/commands.mdx
- Put everything in one file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @miparnisari just merged everything into one file under commands.mdx
, used something similar to the mage gen:docs
of the zed repo, if this looks good, would raise a subsequent PR for adding the workflow in the SpiceDB repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also including the mage command and helper functions used for this.
8e7f169
to
cf4321f
Compare
Signed-off-by: Kartikay <[email protected]>
cf4321f
to
ff2bcb0
Compare
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thanks for sending this!
Generated docs for SpiceDB similar to how it was done for zed.