Skip to content

feat: Add edit button to propose changes to existing docs pages #774

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 14, 2025
Merged

feat: Add edit button to propose changes to existing docs pages #774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d159f2a
Add feature for content.action.edit to edit existing content in GitHub
koverholt Oct 13, 2025
7cc90d0
Merge branch 'main' into add-edit-button
koverholt Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ exclude_docs:
api-reference/java/legal/*

# Repository
repo_name: adk-python
repo_url: https://github.com/google/adk-python
repo_name: adk-docs
repo_url: https://github.com/google/adk-docs
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright Google 2025&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//policies.google.com/terms">Terms</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//policies.google.com/privacy">Privacy</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#__consent">Manage cookies</a>
Expand All @@ -19,6 +20,9 @@ extra_css:
- stylesheets/custom.css

extra:
first_repo_url: https://github.com/google/adk-python
first_repo_name: adk-python
first_repo_icon: fontawesome/brands/github
second_repo_url: https://github.com/google/adk-java
second_repo_name: adk-java
second_repo_icon: fontawesome/brands/github
Expand All @@ -27,8 +31,8 @@ extra:
property: G-DKHZS27PHP
consent:
title: Cookie consent
description: >-
We use cookies to recognize repeated visits and preferences,
description: >-
We use cookies to recognize repeated visits and preferences,
as well as to measure the effectiveness of our documentation and
whether users find the information they need. With your consent,
you're helping us to make our documentation better.
Expand Down Expand Up @@ -58,6 +62,7 @@ theme:
icon: material/brightness-4
name: Switch to light mode
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- content.code.select
Expand Down
16 changes: 8 additions & 8 deletions overrides/partials/source.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<!-- First Repository information -->
<!-- First repository information -->
<a
href="{{ config.repo_url }}"
title="{{ lang.t('source') }}"
href="{{ config.extra.first_repo_url }}"
title="{{ config.extra.first_repo_name or 'First Repository' }}"
class="md-source"
data-md-component="source"
style="margin-right: 10px;"
>
<div class="md-source__icon md-icon">
{% set icon = config.theme.icon.repo or "fontawesome/brands/git-alt" %}
{% include ".icons/" ~ icon ~ ".svg" %}
{% set first_icon = config.extra.first_repo_icon or "fontawesome/brands/github" %}
{% include ".icons/" ~ first_icon ~ ".svg" %}
</div>
<div class="md-source__repository">
{{ config.repo_name }}
{{ config.extra.first_repo_name or 'First Repository' }}
</div>
</a>

<!-- Second Repository information -->
<!-- Second repository information -->
<a
href="{{ config.extra.second_repo_url }}"
title="{{ config.extra.second_repo_name or 'Second Repository' }}"
Expand All @@ -29,4 +29,4 @@
<div class="md-source__repository">
{{ config.extra.second_repo_name or 'Second Repository' }}
</div>
</a>
</a>