Added client docs#47
Merged
Merged
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Secrets |  0  0  0  0 |
View in Orca |
augustas1
approved these changes
May 18, 2026
dannyjameswilliams
force-pushed
the
docs_build
branch
from
May 18, 2026 13:39
21ca321 to
0104f66
Compare
augustas1
reviewed
May 19, 2026
|
|
||
| - name: Deploy preview to gh-pages /preview | ||
| uses: peaceiris/actions-gh-pages@v4 | ||
| with: |
Collaborator
There was a problem hiding this comment.
Claude says because it doesn't have keep_files: true this workflow might clear production docs. May you check this?
Contributor
Author
There was a problem hiding this comment.
I don't think it needs it here because it uses destination_dir so will only clear files at that directory: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-allow-empty-commits-allow_empty_commit
So I need keep_files: false to clear the preview page, but keep_files: true on the root level to stop it wiping the preview
augustas1
approved these changes
May 19, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Mirroring the implementation in Weaviate's TS client, this enables the use of Github Pages to create client documentation according to the docstrings and such from the code.
Uses github actions (modifying the
release.yaml) to automatically push the docs on a release.Also adds docstrings to all major functions and explanations, in parity with the PR for the Python client