Skip to content

docs: give links descriptive text instead of here / link - #2449

Open
AAliKKhan wants to merge 1 commit into
google:mainfrom
AAliKKhan:fix/descriptive-link-text
Open

AAliKKhan wants to merge 1 commit into
google:mainfrom
AAliKKhan:fix/descriptive-link-text

Conversation

@AAliKKhan

Copy link
Copy Markdown
Contributor

Problem

Assistive technology lets people pull up a list of links out of context, where
the accessible name has to stand on its own. Seven links across five files use
a placeholder instead:

File Line Anchor text
docs/get-started/index.md 59 link — the only link on the Get Started landing page
docs/agents/models/litert-lm.md 41 here
docs/integrations/freeplay.md 42 here
docs/integrations/freeplay.md 195 Here
docs/integrations/freeplay.md 200 here
docs/tutorials/agent-team.md 57 here
docs/workflows/patterns.md 1017 here

Fix

Move the noun phrase that already sat next to each link into the anchor, so
the sentence still reads the same in prose but the link says where it goes on
its own:

File Before After
get-started/index.md "check this link" "see the Technical Overview"
agents/models/litert-lm.md "a token for your account [here]" "a [Hugging Face access token]"
integrations/freeplay.md "a full sample ADK agent repo [here]" "the [full sample ADK agent repo]"
integrations/freeplay.md "Here is a code example…" "See the batch test code example…"
integrations/freeplay.md "… Integration [here]" "… the [full Freeplay <> ADK integration]"
tutorials/agent-team.md "… structured for that purpose [here]" "the [equivalent code for that purpose]"
workflows/patterns.md "the full code sample [here]" "the [full code sample]"

Verification

  • every URL is preserved byte-for-byte (checked by substring match on each original target)
  • no [here] / [link] anchors remain in any of the five files
  • mkdocs build --strict on the union of this round's five branches:
    exit 0, 0 warnings

Assistive technology lets users pull up a list of links out of context,
where "here" and "link" convey nothing about the destination. Seven links
across five files now carry the noun phrase that used to sit next to them.

The Get Started landing page also said "check this [link]", which is the only
link on that page.
@netlify

netlify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit 03f7cdd
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6ad5fb584fa69c86ca04c328
😎 Deploy Preview https://deploy-preview-2449--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

This branch has not been deployed

No deployments
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.

1 participant