langchain-ai/langsmith-docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/langsmith-docs.git synced 2026-08-26 17:26:32 -04:00
Code Issues 16 Packages Projects Releases Wiki Activity

[PR #477] [MERGED] fix: upgrade docusaurus to v3.5 to update sitemaps for SEO #535

New Issue
Closed
opened 2026-02-21 17:18:18 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 17:18:18 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/langsmith-docs/pull/477
Author: @jakerachleff
Created: 10/21/2024
Status: ✅ Merged
Merged: 10/22/2024
Merged by: @jakerachleff

Base: main ← Head: 2024-10-21-deprio-old-seo

📝 Commits (10+)

📊 Changes

12 files changed (+4985 additions, -4801 deletions)

View changed files

📝 .gitignore (+1 -0)
📝 docs/reference/authentication_authorization/authentication_methods.mdx (+1 -1)
📝 docs/reference/data_formats/run_data_format.mdx (+1 -1)
📝 docs/self_hosting/faq.mdx (+3 -3)
📝 docs/tutorials/Developers/agents.mdx (+2 -0)
📝 docs/tutorials/Developers/swe-benchmark.mdx (+4 -1)
📝 docusaurus.config.js (+11 -2)
📝 package.json (+12 -11)
📝 src/theme/DocVersionBanner/index.js (+9 -7)
📝 subdirectories/scripts/build_cookbook.py (+42 -1)
📝 versioned_docs/version-old/evaluation/migration.mdx (+1 -1)
📝 yarn.lock (+4898 -4773)

📄 Description

This PR upgrades docusaurus from v2 to v3 so we can take advantage of their latest features.

Changes needed for v2 -> v3 upgrade

  1. Legacy Cookbook Notebook Converter: Had to update our old cookbook notebook converter. This logic now has bad rendering in one special case, which is pandas dataframe outputs no longer show up as tables and instead show up as raw text. That's fine, since cookbooks are old, and only left around for posterity
  2. Link syntax changes: links using ./ instead of ../ were broken. Made fixes where the link checker failed
  3. Special Character Rendering: Had to move some output of python command into output codeblocks to allow rendering of unicode chars
  4. Old Version Banner: Our version banner code relied on internal methods in docusaurus v2, so I did some hacking to make them still show up on our old docs using publicly available APIs

🔄 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/langsmith-docs/pull/477 **Author:** [@jakerachleff](https://github.com/jakerachleff) **Created:** 10/21/2024 **Status:** ✅ Merged **Merged:** 10/22/2024 **Merged by:** [@jakerachleff](https://github.com/jakerachleff) **Base:** `main` ← **Head:** `2024-10-21-deprio-old-seo` --- ### 📝 Commits (10+) - [`db0409e`](https://github.com/langchain-ai/langsmith-docs/commit/db0409efaa088c54b65bcc06b9f8e0b97df5762a) fix: update sitemap settings to prioritize new docs - [`58ca661`](https://github.com/langchain-ai/langsmith-docs/commit/58ca66199df9a0a7faa80c84957c8da339ea0720) going towards d3 - [`9bbc90b`](https://github.com/langchain-ai/langsmith-docs/commit/9bbc90b1d0cd5c688a1312277076e50f01e93a77) version upgrade 3.5 - [`3fa6b89`](https://github.com/langchain-ai/langsmith-docs/commit/3fa6b89d65c3790d178b79e187b2f858b79c506b) try escape - [`25a18b4`](https://github.com/langchain-ai/langsmith-docs/commit/25a18b46992f252486e89a4368e30752bb169482) fix notebook rendering - [`4de2bfb`](https://github.com/langchain-ai/langsmith-docs/commit/4de2bfb64114ad297d8547cf69af36d39c048b28) works but gross - [`639c33f`](https://github.com/langchain-ai/langsmith-docs/commit/639c33f9353a5e4224ae072c0cf0c8faa1f8c1d5) some progress - [`9a8c4e1`](https://github.com/langchain-ai/langsmith-docs/commit/9a8c4e10b3cd137ccd6940439c813660b8861470) fix - [`1094677`](https://github.com/langchain-ai/langsmith-docs/commit/1094677b56743f5b235b6e6df787ec16db703186) fix - [`59db32e`](https://github.com/langchain-ai/langsmith-docs/commit/59db32ed48e446911b569297e5ceb0c5e654464b) v1.22.22 ### 📊 Changes **12 files changed** (+4985 additions, -4801 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+1 -0) 📝 `docs/reference/authentication_authorization/authentication_methods.mdx` (+1 -1) 📝 `docs/reference/data_formats/run_data_format.mdx` (+1 -1) 📝 `docs/self_hosting/faq.mdx` (+3 -3) 📝 `docs/tutorials/Developers/agents.mdx` (+2 -0) 📝 `docs/tutorials/Developers/swe-benchmark.mdx` (+4 -1) 📝 `docusaurus.config.js` (+11 -2) 📝 `package.json` (+12 -11) 📝 `src/theme/DocVersionBanner/index.js` (+9 -7) 📝 `subdirectories/scripts/build_cookbook.py` (+42 -1) 📝 `versioned_docs/version-old/evaluation/migration.mdx` (+1 -1) 📝 `yarn.lock` (+4898 -4773) </details> ### 📄 Description This PR upgrades docusaurus from v2 to v3 so we can take advantage of their latest features. ## Changes needed for v2 -> v3 upgrade 1. **Legacy Cookbook Notebook Converter**: Had to update our old cookbook notebook converter. This logic now has bad rendering in one special case, which is pandas dataframe outputs no longer show up as tables and instead show up as raw text. That's fine, since cookbooks are old, and only left around for posterity 2. **Link syntax changes**: links using ./ instead of ../ were broken. Made fixes where the link checker failed 3. **Special Character Rendering**: Had to move some output of python command into output codeblocks to allow rendering of unicode chars 4. **Old Version Banner**: Our version banner code relied on internal methods in docusaurus v2, so I did some hacking to make them still show up on our old docs using publicly available APIs --- <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-21 17:18:18 -05:00
yindo closed this issue 2026-02-21 17:18:18 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langsmith-docs#535
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?