Skip to content

Conversation

mdrxy
Copy link
Collaborator

@mdrxy mdrxy commented Oct 16, 2025

updated x-ref parser to escape inner code backticks

begin x-reffing in main docs

dropped old refs site from link map

@Copilot Copilot AI review requested due to automatic review settings October 16, 2025 03:34
@github-actions github-actions bot added langchain For docs changes to LangChain langgraph For docs changes to LangGraph langsmith For docs changes to LangSmith python For content related to the Python version of LangChain projects oss javascript docs-infra labels Oct 16, 2025
Copy link
Contributor

Preview ID generated: preview-mdrxym-1760585708-f5b8dd4

Copy link
Contributor

@Copilot Copilot AI left a comment

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 updates documentation to use a new cross-reference linking syntax (@[...]) for Python API references. The changes introduce support for automatically linking to the new reference documentation site and update model references from the outdated claude-3-7-sonnet-latest to the correct claude-sonnet-4-5-20250929 version.

Key changes:

  • Implementation of @[...] syntax for Python API cross-references with support for backticks and custom titles
  • Migration of hardcoded API links to the new automated linking system
  • Update of Anthropic model references throughout documentation
  • Addition of griffe-inherited-docstrings dependency for better API documentation
  • Expansion of Python reference documentation structure

Reviewed Changes

Copilot reviewed 49 out of 50 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/snippets/oss/ui-py.mdx Remove parentheses from create_agent() function reference
src/snippets/oss/studio.mdx Convert to new @[...] linking syntax
src/oss/python/releases/langchain-v1.mdx Convert multiple API references to new linking syntax and fix middleware name
src/oss/python/migrate/langchain-v1.mdx Convert API references and improve code example formatting
src/oss/python/integrations/tools/TEMPLATE.mdx Update Anthropic model version
src/oss/python/integrations/retrievers/*.mdx Remove unnecessary .invoke method references
src/oss/python/integrations/providers/*.mdx Update provider icons and naming
src/oss/python/integrations/chat/*.mdx Update model versions and remove method references
src/oss/langgraph/*.mdx Update model versions and convert references to new syntax
src/oss/langchain/*.mdx Convert API references throughout to new linking syntax
reference/python/pyproject*.toml Add griffe-inherited-docstrings dependency
reference/python/mkdocs.yml Configure inherited docstrings and external inventories
reference/python/docs/*.md Expand reference documentation structure
reference/python/README.md Add comprehensive linking syntax documentation
pipeline/preprocessors/link_map.py Add extensive Python API reference link mappings
pipeline/preprocessors/handle_auto_links.py Implement backtick support in cross-reference regex

### `.text()` is now a property

Use of the `.text()` method on message objects should drop the parentheses:

Copy link

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

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

This code example shows both the new and deprecated approaches in a single block without clear separation. Consider splitting this into a 'before/after' comparison or adding clearer inline comments to distinguish which pattern is correct versus deprecated.

Copilot uses AI. Check for mistakes.

@mdrxy mdrxy merged commit 46bfbbf into main Oct 16, 2025
11 checks passed
@mdrxy mdrxy deleted the mdrxy/more-10-15 branch October 16, 2025 03:36
jeongsk pushed a commit to jeongsk/langchain-docs that referenced this pull request Oct 17, 2025
updated x-ref parser to escape inner code backticks

begin x-reffing in main docs

dropped old refs site from link map
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-infra javascript langchain For docs changes to LangChain langgraph For docs changes to LangGraph langsmith For docs changes to LangSmith oss python For content related to the Python version of LangChain projects

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant