[PR #1245] [MERGED] docs: wrap package names in backticks instead of bold formatting #1326

Closed
opened 2026-02-15 20:15:17 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/langgraphjs/pull/1245
Author: @christian-bromann
Created: 5/30/2025
Status: Merged
Merged: 6/20/2025
Merged by: @dqbd

Base: mainHead: cb/quickstart-fix


📝 Commits (1)

  • 0dd11f0 docs: wrap package names in backticks instead of bold formatting

📊 Changes

1 file changed (+3 additions, -3 deletions)

View changed files

📝 examples/quickstart.ipynb (+3 -3)

📄 Description

🐛 Problem Solved

The documentation system was incorrectly interpreting the bold-formatted package names as markdown links, attempting to navigate to non-existent pages. This created broken links and a poor user experience when users clicked on what appeared to be clickable package names.

Screenshot 2025-05-30 at 4 00 12 PM

🔧 Changes Made

  • Updated package name formatting in examples/quickstart.ipynb
  • Changed bold formatting (**package**) to inline code formatting (**package**) for:
    • @langchain/langgraph
    • @langchain/openai
    • @langchain/community

Solution

By wrapping the package names in backticks within the bold formatting (**package**), we:

  • Maintain the visual emphasis of the package names
  • Prevent them from being interpreted as links
  • Follow proper markdown conventions for code/package references
  • Improve the overall documentation experience

📍 Files Changed

  • examples/quickstart.ipynb - Updated package name formatting in the dependencies section

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/langgraphjs/pull/1245 **Author:** [@christian-bromann](https://github.com/christian-bromann) **Created:** 5/30/2025 **Status:** ✅ Merged **Merged:** 6/20/2025 **Merged by:** [@dqbd](https://github.com/dqbd) **Base:** `main` ← **Head:** `cb/quickstart-fix` --- ### 📝 Commits (1) - [`0dd11f0`](https://github.com/langchain-ai/langgraphjs/commit/0dd11f0b782c63bd1570e9483770e20507f60651) docs: wrap package names in backticks instead of bold formatting ### 📊 Changes **1 file changed** (+3 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `examples/quickstart.ipynb` (+3 -3) </details> ### 📄 Description ### 🐛 **Problem Solved** The documentation system was incorrectly interpreting the bold-formatted package names as markdown links, attempting to navigate to non-existent pages. This created broken links and a poor user experience when users clicked on what appeared to be clickable package names. <img width="260" alt="Screenshot 2025-05-30 at 4 00 12 PM" src="https://github.com/user-attachments/assets/2dfcf4a5-52f7-4f88-bcab-c4bebd85c1af" /> ### 🔧 **Changes Made** - Updated package name formatting in `examples/quickstart.ipynb` - Changed bold formatting (`**package**`) to inline code formatting (`**`package`**`) for: - `@langchain/langgraph` - `@langchain/openai` - `@langchain/community` ### ✅ **Solution** By wrapping the package names in backticks within the bold formatting (`**`package`**`), we: - Maintain the visual emphasis of the package names - Prevent them from being interpreted as links - Follow proper markdown conventions for code/package references - Improve the overall documentation experience ### 📍 **Files Changed** - `examples/quickstart.ipynb` - Updated package name formatting in the dependencies section --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 20:15:17 -05:00
yindo closed this issue 2026-02-15 20:15:17 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langgraphjs#1326