Move rst docs gen from website repo #280
Merged
Conversation
This file contains 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
fmoor
reviewed
Jul 24, 2023
.github/workflows/push-docs.sh
Outdated
| git config user.email releases@edgedb.com | ||
| git add . | ||
|
|
||
| if ! git diff --cached --exit-code > /dev/null; |
There was a problem hiding this comment.
What do you think about requiring the PR author to run make gendocs and adding this check to the regular workflow as a lint? This way the rendered rst changes are part of the code review. It is somewhat redundant in terms of reviewing documentation content but could help catch errors in the rst rendering code particularly as godoc syntax evolves.
fmoor
approved these changes
Jul 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.