docs: Bring back Python SDK reference#1415
Conversation
Summary of ChangesHello @ishymko, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a critical issue where the Python SDK reference link in the documentation was broken, preventing users from accessing essential API information. By updating the navigation link to the correct, auto-generated path, it significantly improves the user experience for developers seeking Python SDK details. Furthermore, the changes ensure that all copyright and authorship information across the documentation is current and accurately reflects 'The Linux Foundation' as the project's steward. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a broken link to the Python SDK reference and updates copyright information across the documentation configuration. I've added a couple of minor suggestions to automate the copyright year updates in both mkdocs.yml and docs/sdk/python/conf.py. This would improve long-term maintainability by removing the need for manual year changes. Otherwise, the changes look good.
a2a3809 to
373a50a
Compare
373a50a to
4fce3ba
Compare
Currently
SDK Reference > Pythonlink gives 404:python.md(the one not used ever before, it used to bepython/index.md) in docs(spec): Large refactor of specification to separate application protocol definition from mapping to transports. #1160.latest. This is required due to Existing .html Redirect mkdocs/mkdocs-redirects#18, current way isn't going to work.v0.3.0tag of the website (the one you get after clickingLatest Released Versionfrom here) doesn't have the generated documentation either way, see here.Google LLCwithThe Linux Foundationin the generated SDK reference.Tested via
mkdocs serve.Fixes #1347.