Skip to content

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

Merged
merged 1 commit into from
Jul 6, 2025
Merged

SpiceDB: add docs #298

merged 1 commit into from
Jul 6, 2025

Conversation

kartikaysaxena
Copy link
Contributor

Generated docs for SpiceDB similar to how it was done for zed.

Screenshot 2025-01-20 at 10 53 24 PM

Copy link

vercel bot commented Jan 20, 2025

@kartikaysaxena is attempting to deploy a commit to the Authzed Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@miparnisari miparnisari left a 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.

@@ -4,5 +4,6 @@
"modeling": "Modeling & Integrating",
"ops": "Operations",
"api": "API Reference",
"links": "Links"
"links": "Links",
"docs": "CLI Docs"
Copy link
Contributor

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

  1. Re-use the existing page: https://github.com/authzed/docs/blob/main/pages/spicedb/concepts/commands.mdx
  2. Put everything in one file

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

Signed-off-by: Kartikay <[email protected]>
Copy link

vercel bot commented Jul 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 6, 2025 11:42pm

Copy link
Contributor

@miparnisari miparnisari left a 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!

@miparnisari miparnisari merged commit 5806402 into authzed:main Jul 6, 2025
6 of 7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jul 6, 2025
@kartikaysaxena kartikaysaxena deleted the spicedb-docs branch July 8, 2025 03:27
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.

2 participants