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

[PR #484] [CLOSED] feat: organize docs within flat diataxis structure #539

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

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/langsmith-docs/pull/484
Author: @jakerachleff
Created: 10/23/2024
Status: ❌ Closed

Base: main ← Head: 2024-10-22-smaller-reorg-just-howtos

📝 Commits (2)

  • 1679bbd feat: organize docs within flat diataxis structure
  • 46651fb fix

📊 Changes

15 files changed (+178 additions, -278 deletions)

View changed files

📝 docs/concepts/admin.mdx (+11 -11)
📝 docs/concepts/evaluation.mdx (+8 -8)
📝 docs/concepts/index.md (+11 -31)
📝 docs/concepts/prompts.mdx (+0 -0)
📝 docs/concepts/tracing.mdx (+8 -8)
📝 docs/how_to_guides/index.md (+112 -211)
📝 docs/how_to_guides/setup/create_account_api_key.mdx (+1 -1)
📝 docs/how_to_guides/setup/manage_organization_by_api.mdx (+1 -1)
📝 docs/how_to_guides/setup/set_up_access_control.mdx (+1 -1)
📝 docs/how_to_guides/setup/set_up_saml_sso.mdx (+1 -1)
📝 docs/how_to_guides/setup/set_up_workspace.mdx (+1 -1)
📝 docs/tutorials/index.md (+10 -4)
📝 docusaurus.config.js (+3 -0)
📝 sidebars.js (+6 -0)
📝 src/css/custom.css (+4 -0)

📄 Description

Proposed Change

As an alternative to #479 , we can lean further into the diataxis structure. This makes a few changes to make the diataxis flat structure work better:

  1. Top Level Page Organization: how to guides, tutorials, and concepts within the top level page more clearly. The right side bar now has easy headers to find guides for different parts of our product (e.g. evaluate with the SDK). Lots of subheaders were removed that overcrowded the how to guides, and similar guides / tutorials are grouped together
  2. Bye Bye Expanding Sidebar: Remove the expanding side bar on the left. Now, it just shows that you're in How-to Guides or Concepts or Tutorials. We should stop having people use this for navigation since it makes the experience worse.

Outstanding TODOs

Still TODO:

  • Billing Concepts in admin page

🔄 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/484 **Author:** [@jakerachleff](https://github.com/jakerachleff) **Created:** 10/23/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `2024-10-22-smaller-reorg-just-howtos` --- ### 📝 Commits (2) - [`1679bbd`](https://github.com/langchain-ai/langsmith-docs/commit/1679bbdf63240ecae8bae21f69b2072277cd7f4c) feat: organize docs within flat diataxis structure - [`46651fb`](https://github.com/langchain-ai/langsmith-docs/commit/46651fbd9472f6ab316ed14308e9bfc6551b63b3) fix ### 📊 Changes **15 files changed** (+178 additions, -278 deletions) <details> <summary>View changed files</summary> 📝 `docs/concepts/admin.mdx` (+11 -11) 📝 `docs/concepts/evaluation.mdx` (+8 -8) 📝 `docs/concepts/index.md` (+11 -31) 📝 `docs/concepts/prompts.mdx` (+0 -0) 📝 `docs/concepts/tracing.mdx` (+8 -8) 📝 `docs/how_to_guides/index.md` (+112 -211) 📝 `docs/how_to_guides/setup/create_account_api_key.mdx` (+1 -1) 📝 `docs/how_to_guides/setup/manage_organization_by_api.mdx` (+1 -1) 📝 `docs/how_to_guides/setup/set_up_access_control.mdx` (+1 -1) 📝 `docs/how_to_guides/setup/set_up_saml_sso.mdx` (+1 -1) 📝 `docs/how_to_guides/setup/set_up_workspace.mdx` (+1 -1) 📝 `docs/tutorials/index.md` (+10 -4) 📝 `docusaurus.config.js` (+3 -0) 📝 `sidebars.js` (+6 -0) 📝 `src/css/custom.css` (+4 -0) </details> ### 📄 Description ## Proposed Change As an alternative to #479 , we can lean further into the diataxis structure. This makes a few changes to make the diataxis flat structure work better: 1. **Top Level Page Organization**: how to guides, tutorials, and concepts within the top level page more clearly. The right side bar now has easy headers to find guides for different parts of our product (e.g. evaluate with the SDK). Lots of subheaders were removed that overcrowded the how to guides, and similar guides / tutorials are grouped together 2. **Bye Bye Expanding Sidebar**: Remove the expanding side bar on the left. Now, it just shows that you're in How-to Guides or Concepts or Tutorials. We should stop having people use this for navigation since it makes the experience worse. ## Outstanding TODOs Still TODO: - Billing Concepts in admin page --- <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:19 -05:00
yindo closed this issue 2026-02-21 17:18:19 -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#539
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?