Documentation Updates #1097
Merged
Documentation Updates #1097
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
Signed-off-by: Ethan S. Chen <ethanschen@163.com>
csmarchbanks
approved these changes
Mar 17, 2025
There was a problem hiding this comment.
Thanks! I like the improvement to the home page and thank you for the updates. Pinging @marctc as well just to see if he has any comments as the original author of the doc site.
marctc
approved these changes
Mar 18, 2025
, thanks a lot for adding some love the docs!|
fyi @fstab, in case you want some of the new features added here to the java client docs |
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.
Preview Link
Before merging this MR, you can preview all changes at:
https://www.ethans.space/client_python/
Key Changes
New Edit Button
Added an "Edit" button in the top-right corner of documentation articles for easier contributions.
Open Source License
Added a clear open source license notice in the website footer.
Improved Homepage
Replaced the minimal homepage with a dedicated "Getting Started" section to better orient new users.
Addition
This MR addresses frequent user requests for improved documentation. Future work will focus on enhancing incomplete functional demonstrations that have been raised as a key concern.