auto-generate more complete docs #503
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miparnisari
force-pushed
the
amend-docs
branch
2 times, most recently
from
b4209c1 to
564eae3
Compare
miparnisari
commented
Apr 28, 2025
| dist/ | ||
| temp/ | ||
| docs/ | ||
| docs/merged.md |
Contributor
Author
There was a problem hiding this comment.
I don't love this tbh 🤔
Contributor
There was a problem hiding this comment.
Ignoring this specific file?
miparnisari
force-pushed
the
amend-docs
branch
3 times, most recently
from
9ac6c37 to
201a216
Compare
miparnisari
force-pushed
the
amend-docs
branch
4 times, most recently
from
492006a to
1bf693b
Compare
tstirrat15
approved these changes
May 1, 2025
Contributor
tstirrat15
left a comment
tstirrat15
left a comment
There was a problem hiding this comment.
LGTM as is; we can modify further if needed.
| dist/ | ||
| temp/ | ||
| docs/ | ||
| docs/merged.md |
Contributor
There was a problem hiding this comment.
Ignoring this specific file?
| DOCS_BRANCH: "main" | ||
| GENERATED_DOCS_FILE: "docs/zed.md" | ||
| TARGET_DOCS_FILE: "pages/zed/zed.md" | ||
| TARGET_DOCS_FILE: "pages/spicedb/getting-started/installing-zed.mdx" |
Contributor
There was a problem hiding this comment.
This makes me wonder if we should reorganize this page on the docs side.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR attempts to make the public-facing docs (https://authzed.com/docs/spicedb/getting-started/installing-zed) more complete by including both installation docs and a reference to all the commands.
The idea:
docs/now contains 2 filesgetting-startedis what exists today in https://authzed.com/docs/spicedb/getting-started/installing-zed and what exists in today's README (I don't love the duplication 😢 )zed.mdis auto-generated viamage gen:docsThen on every PR, we run
mage gen:docsForPublishwhich generatesdocs/merged.mdand pushes it to the docs repo.Testing
Run
mage gen:docsForPublishand look atdocs/merged.md😄