-
Notifications
You must be signed in to change notification settings - Fork 221
feat: add code source references and related page tagging; emits Rela… #832
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
Merged
notowen333
merged 5 commits into
strands-agents:main
from
notowen333:headless-improvement
May 14, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1c4e3c7
feat: add code source references and related page tagging; emits Rela…
1644cc9
fix: remove source references in frontmatter; add related pages to us…
f8fea4d
feat: tag-driven Related Pages with specificity-weighted scoring
notowen333 11826be
chore(related-docs): trim hedging in score-floor comment, refresh tes…
notowen333 6e3be7c
feat: drop HTML "See also" pill row; keep headless related-links
notowen333 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import fs from 'node:fs' | ||
| import { fileURLToPath } from 'node:url' | ||
| import yaml from 'js-yaml' | ||
| import { z } from 'astro/zod' | ||
|
|
||
| const TAGS_YML = fileURLToPath(new URL('./tags.yml', import.meta.url)) | ||
|
|
||
| function loadAllowedTags(): readonly string[] { | ||
| const raw = yaml.load(fs.readFileSync(TAGS_YML, 'utf-8')) | ||
| if (!Array.isArray(raw) || !raw.every((t): t is string => typeof t === 'string')) { | ||
| throw new Error(`[tags] ${TAGS_YML} must be a flat YAML list of strings`) | ||
| } | ||
| const deduped = Array.from(new Set(raw)) | ||
| if (deduped.length !== raw.length) { | ||
| const dupes = raw.filter((t, i) => raw.indexOf(t) !== i) | ||
| throw new Error(`[tags] ${TAGS_YML} contains duplicate entries: ${[...new Set(dupes)].join(', ')}`) | ||
| } | ||
| return deduped | ||
| } | ||
|
|
||
| export const ALLOWED_TAGS = loadAllowedTags() | ||
|
|
||
| export const TagSchema = z.enum(ALLOWED_TAGS as readonly [string, ...string[]]) | ||
|
|
||
| export type Tag = z.infer<typeof TagSchema> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Allowed tag vocabulary for user-guide pages. Drives the headless | ||
| # "Related pages" block (in /<slug>/index.md, /llms-full.txt, and JSON-LD | ||
| # `relatedLink`). Not surfaced on the rendered HTML — agent-facing only. | ||
| # Validated by Zod (src/content.config.ts) — unknown tags fail the build. | ||
| # | ||
| # THE RULE: a tag means "this page TEACHES the named thing." Not "mentions | ||
| # it" or "has a section labeled with it." If a reader landed on the page | ||
| # looking to learn the tagged topic, they should leave understanding it. | ||
| # | ||
| # Common traps to avoid: | ||
| # - Section heading matches tag name. A model provider with a "Streaming" | ||
| # section is not teaching streaming — the section says "yes, this | ||
| # provider supports it." Don't tag the provider page with `streaming`. | ||
| # - Page mentions X in passing. References to other pages don't warrant | ||
| # tags. Tag for what the page IS, not what it links to. | ||
| # - Lifecycle bloat. Words like "production" feel applicable to anything | ||
| # serious. We removed `production` for this reason — it labeled a | ||
| # property, not a topic. | ||
| # - Over-tagging. 6+ tags dilutes the page's coordinates and makes it | ||
| # match too broadly. Aim for 2-4 tags that each name a primary topic. | ||
| # | ||
| # Authoring checklist: | ||
| # 1. Does this page TEACH the tag? If not, leave it off. | ||
| # 2. Would this page be a useful related-link for every other tag-mate? | ||
| # 3. Is the tag a primary topic, or just mentioned? Tag only primaries. | ||
| # 4. When in doubt, leave the tag off. Empty related-links beat misleading. | ||
| # | ||
| # Adding a new tag = PR editing this file. Every tag must apply to ≥2 | ||
| # pages and meaningfully bridge across sidebar sections. | ||
|
|
||
| # Topics / domains — specific products, protocols, data types | ||
|
notowen333 marked this conversation as resolved.
|
||
| - agentcore | ||
| - aws | ||
| - bedrock | ||
| - mcp | ||
| - pii | ||
| - vision | ||
|
|
||
| # Capabilities — what the page teaches the reader to do | ||
| - bidi-streaming | ||
| - caching | ||
| - conversation-management | ||
| - error-handling | ||
| - event-loop | ||
| - failure-diagnosis | ||
| - hooks | ||
| - local-models | ||
| - multi-agent | ||
| - multimodal-evaluation | ||
| - prompt-authoring | ||
| - session-management | ||
| - simulation | ||
| - snapshots | ||
| - state | ||
| - streaming | ||
| - structured-output | ||
| - token-management | ||
| - tool-authoring | ||
| - tool-evaluation | ||
| - tool-execution | ||
|
|
||
| # Lifecycle / practice — where in the dev lifecycle this sits | ||
| - deployment | ||
| - observability | ||
| - quickstart | ||
| - safety | ||
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
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
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/agents/conversation-management.mdx
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
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
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/agents/retry-strategies.mdx
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/agents/session-management.mdx
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
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/agents/structured-output.mdx
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/bidirectional-streaming/agent.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: BidiAgent | ||
| experimental: true | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/bidirectional-streaming/events.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: Events | ||
| experimental: true | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
5 changes: 4 additions & 1 deletion
5
src/content/docs/user-guide/concepts/bidirectional-streaming/hooks.mdx
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/bidirectional-streaming/interruption.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: Interruptions | ||
| experimental: true | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ title: I/O Channels | |
| experimental: true | ||
| sidebar: | ||
| label: "IO" | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
...content/docs/user-guide/concepts/bidirectional-streaming/models/gemini_live.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: Gemini Live | ||
| experimental: true | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/bidirectional-streaming/models/nova_sonic.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: Nova Sonic | ||
| experimental: true | ||
| tags: [bidi-streaming, aws, bedrock] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
...ent/docs/user-guide/concepts/bidirectional-streaming/models/openai_realtime.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: OpenAI Realtime | ||
| experimental: true | ||
| tags: [bidi-streaming] | ||
| --- | ||
|
|
||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/bidirectional-streaming/quickstart.mdx
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
5 changes: 4 additions & 1 deletion
5
...content/docs/user-guide/concepts/bidirectional-streaming/session-management.mdx
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/experimental/agent-config.mdx
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
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/model-providers/amazon-bedrock.mdx
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
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/model-providers/anthropic.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: Anthropic | ||
| tags: [structured-output, caching] | ||
| integrationType: model-provider | ||
| --- | ||
|
|
||
|
|
||
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/model-providers/custom_model_provider.mdx
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
1 change: 1 addition & 0 deletions
1
src/content/docs/user-guide/concepts/model-providers/google.mdx
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.