docs: wrap package names in backticks instead of bold formatting #1245
Conversation
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
- Changed **@langchain/langgraph** to **`@langchain/langgraph`** - Changed **@langchain/openai** to **`@langchain/openai`** - Changed **@langchain/community** to **`@langchain/community`** This prevents the documentation system from interpreting these package names as links to non-existent pages while maintaining proper code formatting for package references.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🐛 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.
🔧 Changes Made
examples/quickstart.ipynb**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:📍 Files Changed
examples/quickstart.ipynb- Updated package name formatting in the dependencies section