Skip to content

fix: chg repo to adk-docs to help redirect users to repo for docs #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

polong-lin
Copy link
Collaborator

Users have been reporting documentation issues in adk-python, which is the repo for the SDK itself (not the documentation). This will make the docs page point to the docs repo (adk-repo) instead to so that users naturally report bugs directly in the docs repo.

@polong-lin
Copy link
Collaborator Author

Please hold on merging this PR for now.

@koverholt
Copy link
Collaborator

An alternative option to this might be to disable issues in the adk-docs repo, point users to file issues in adk-python, possibly add a docs issue template, then we can label and manage docs from that one repo, if it makes sense. But happy to discuss more and determine the best options for the community!

@hangfei
Copy link
Collaborator

hangfei commented Apr 13, 2025

Agree. Let's hold this change.

I have updated adk Python repo template to redirect the traffic. I think the doc PR has gone gone.

I believe the community convention is stll to have the source code repo on the top right.

@AshleyHenry15
Copy link
Contributor

Bringing the docs into the SDK repo has many advantages, such as triaging (is this a docs-only issue or a feature refactor), a developer's ability to make a code contribution and update the docs in a single repo/PR if you have release notes—you can easily link back to the issues, and you can also auto-build code examples and snippets into the docs (less documentation maintenance).

If you can hot release docs outside of "product releases," having the code and the docs under the same roof has many advantages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants