Skip to content

docs(strands): cross-link the Python and TypeScript Strands guides - #181

Merged
Andy2003 merged 1 commit into
neo4j-labs:mainfrom
Andy2003:docs/strands-guide-cross-links
Aug 19, 2026
Merged

docs(strands): cross-link the Python and TypeScript Strands guides#181
Andy2003 merged 1 commit into
neo4j-labs:mainfrom
Andy2003:docs/strands-guide-cross-links

Conversation

@Andy2003

@Andy2003 Andy2003 commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Why

The Strands integrations catalog card (merged in strands-agents/harness-sdk#3757) carries a single docsUrl, pointing at the Python guide. Strands declined to host an on-site docs page (harness-sdk#3871) because partner pages drift stale in their repo, so that one link is now the only route in — and a TypeScript reader following it landed on the Python guide with nothing pointing onward. Neither guide mentioned the other.

What

  • how-to/integrations/aws-strands.adoc — NOTE at the top naming the TypeScript guide, plus a See Also entry.
  • how-to/typescript/strands.adoc — NOTE at the top naming the Python guide, plus a See also entry.
  • how-to/typescript/integrations-overview.adoc — added the missing Strands (TypeScript) section; the overview listed every framework except Strands.

Each NOTE carries the one fact a reader needs before switching: Python covers both backends (NAMS and self-hosted Neo4j/Aura over Bolt) and offers the session manager with opt-in retrieval injection plus agent-callable memory tools; TypeScript is NAMS-only and wires SnapshotStorage, ConversationManager, and reasoning hooks.

Testing

  • make test-docs-links — 13 passed
  • make test-docs-syntax — 579 passed, 91 skipped
  • All three touched pages convert cleanly through Asciidoctor

make test-docs-build fails locally for an unrelated reason: Antora 3.1.14 exits 0 producing no output on Node v24.16.0, reproduced on a throwaway minimal component. Not caused by this change, but worth confirming which Node the docs CI job and Vercel run.

Docs-only, so per the path filters this triggers Python CI and not TypeScript CI.

🤖 Generated with Claude Code

The Strands integrations catalog card carries a single docsUrl, which points
at the Python guide — so a TypeScript reader landed on the wrong page with no
route onward. Neither guide mentioned the other.

- NOTE at the top of each guide naming the other, plus the one fact that
  differs: Python covers NAMS and bolt with the session manager and
  agent-callable tools; TypeScript is NAMS-only and wires SnapshotStorage,
  ConversationManager and reasoning hooks.
- Reciprocal entry in each guide's See Also.
- typescript/integrations-overview.adoc: add the missing Strands section —
  the overview listed every framework except Strands.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

@Andy2003 is attempting to deploy a commit to the lyonwj's projects Team on Vercel.

A member of the Team first needs to authorize it.

@codecov-commenter

codecov-commenter commented Aug 19, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@4eb4445). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #181   +/-   ##
=======================================
  Coverage        ?   65.00%           
=======================================
  Files           ?      136           
  Lines           ?    12992           
  Branches        ?     1908           
=======================================
  Hits            ?     8446           
  Misses          ?     4003           
  Partials        ?      543           
Flag Coverage Δ
integration 43.51% <ø> (?)
merged 65.00% <ø> (?)
unit 50.97% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves navigability between the Python and TypeScript AWS Strands Agents documentation by adding explicit cross-links and ensuring the TypeScript integrations overview includes Strands.

Changes:

  • Added reciprocal top-of-page NOTE blocks in the Python and TypeScript Strands guides to direct readers to the other language’s guide and clarify feature/back-end differences.
  • Added reciprocal “See also/See Also” cross-references between the two Strands guides.
  • Added a missing “Strands Agents (TypeScript)” section to the TypeScript integrations overview (and updated the page description accordingly).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/modules/ROOT/pages/how-to/typescript/strands.adoc Adds a top NOTE and a See also cross-link pointing TypeScript readers to the Python Strands guide (and clarifies TS is NAMS-only).
docs/modules/ROOT/pages/how-to/typescript/integrations-overview.adoc Adds a Strands Agents (TypeScript) section (with example) and updates the description metadata to include Strands.
docs/modules/ROOT/pages/how-to/integrations/aws-strands.adoc Adds a top NOTE and a See Also cross-link pointing Python readers to the TypeScript Strands guide (and clarifies backend/surface differences).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Andy2003 Andy2003 added the documentation Improvements or additions to documentation label Aug 19, 2026
@Andy2003 Andy2003 self-assigned this Aug 19, 2026
@Andy2003
Andy2003 merged commit 79ad455 into neo4j-labs:main Aug 19, 2026
18 of 19 checks passed
@Andy2003
Andy2003 deleted the docs/strands-guide-cross-links branch August 19, 2026 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants