Skip to content

Conversation

@sydney-runkle
Copy link
Contributor

@sydney-runkle sydney-runkle commented Oct 11, 2025

just scoped to oss folder for now

  • removing old style comment + annotation syntax
  • removing highlight={X,Y,Z} syntax in favor of # [!code highlight] syntax inline
  • some of @hwchase17's initial docs feedback 👍

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

Preview ID generated: preview-change-1760200915-0b131ec

Copy link
Contributor

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 pull request updates code highlighting syntax across the LangChain documentation by replacing the traditional highlight={lines} format with # [!code highlight] comments. The change affects numerous MDX files, including migration guides, integration documentation, and conceptual guides. Additionally, some content has been reorganized, such as moving the "Simplified package" section earlier in the LangChain v1 migration guide and removing a section about using tools with agents.

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
src/oss/python/migrate/langchain-v1.mdx Reorganized content structure and updated code highlighting syntax
src/oss/python/integrations/chat/openai.mdx Updated code highlighting from highlight={} to # [!code highlight] comments
src/oss/python/integrations/chat/anthropic.mdx Updated code highlighting syntax throughout the file
src/oss/langgraph/use-subgraphs.mdx Updated code highlighting and comment formatting
src/oss/langgraph/use-graph-api.mdx Updated code highlighting syntax in multiple code blocks
src/oss/langgraph/use-functional-api.mdx Updated code highlighting and comment formatting
src/oss/langgraph/streaming.mdx Updated code highlighting syntax throughout
src/oss/langgraph/interrupts.mdx Updated code highlighting in interrupt configuration examples
src/oss/langgraph/graph-api.mdx Updated code highlighting syntax
src/oss/langgraph/functional-api.mdx Updated code highlighting and comment formatting
src/oss/langgraph/durable-execution.mdx Updated code highlighting in task examples
src/oss/langgraph/add-memory.mdx Updated code highlighting throughout memory configuration examples
src/oss/langgraph/INVALID_CONCURRENT_GRAPH_UPDATE.mdx Updated code highlighting in error documentation
src/oss/langchain/tools.mdx Removed "Use tools with agents" section
src/oss/langchain/test.mdx Updated code highlighting in testing examples
src/oss/langchain/streaming.mdx Updated code highlighting and reorganized headings
src/oss/langchain/short-term-memory.mdx Updated code highlighting throughout memory examples
src/oss/langchain/overview.mdx Minor content updates to improve clarity
src/oss/langchain/models.mdx Updated code highlighting syntax
src/oss/langchain/mcp.mdx Updated code highlighting in MCP client examples
src/oss/langchain/evals.mdx Updated code highlighting in evaluation examples
src/oss/concepts/context.mdx Updated code highlighting and removed explanatory comments

@sydney-runkle sydney-runkle changed the title oss: change how we highlight code snippets oss: code snippet fixes + other minor changes Oct 11, 2025
@github-actions
Copy link
Contributor

Preview ID generated: preview-change-1760201213-6b6ab1a

@sydney-runkle sydney-runkle merged commit 33edf15 into main Oct 11, 2025
11 checks passed
@sydney-runkle sydney-runkle deleted the change-content-highlights branch October 11, 2025 16:48
mdrxy pushed a commit that referenced this pull request Oct 13, 2025
just scoped to oss folder for now
* removing old style comment + annotation syntax
* removing `highlight={X,Y,Z}` syntax in favor of `# [!code highlight]`
syntax inline
* some of @hwchase17's initial docs feedback 👍
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

langchain For docs changes to LangChain langgraph For docs changes to LangGraph 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.

2 participants