[PR #479] [CLOSED] [feat: organize docs by feature area] #536

Closed
opened 2026-02-21 17:18:18 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

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

Base: mainHead: 2024-10-22-site-reorg


📝 Commits (10+)

📊 Changes

361 files changed (+1087 additions, -1151 deletions)

View changed files

docs/administration/concepts/index.mdx (+404 -0)
📝 docs/administration/concepts/static/org_members_settings.png (+0 -0)
📝 docs/administration/concepts/static/org_settings_workspaces_tab.png (+0 -0)
📝 docs/administration/concepts/static/resource_tags.png (+0 -0)
📝 docs/administration/concepts/static/roles_tab_rbac.png (+0 -0)
📝 docs/administration/concepts/static/sample_workspace.png (+0 -0)
docs/administration/how_to_guides/index.md (+28 -0)
📝 docs/administration/how_to_guides/organization_management/_category_.json (+0 -0)
📝 docs/administration/how_to_guides/organization_management/create_account_api_key.mdx (+3 -3)
docs/administration/how_to_guides/organization_management/index.jsx (+13 -0)
📝 docs/administration/how_to_guides/organization_management/manage_organization_by_api.mdx (+5 -5)
📝 docs/administration/how_to_guides/organization_management/set_up_access_control.mdx (+5 -5)
📝 docs/administration/how_to_guides/organization_management/set_up_billing.mdx (+4 -4)
📝 docs/administration/how_to_guides/organization_management/set_up_organization.mdx (+6 -6)
📝 docs/administration/how_to_guides/organization_management/set_up_resource_tags.mdx (+5 -5)
📝 docs/administration/how_to_guides/organization_management/set_up_saml_sso.mdx (+6 -6)
📝 docs/administration/how_to_guides/organization_management/set_up_workspace.mdx (+4 -4)
📝 docs/administration/how_to_guides/organization_management/static/assign_role.png (+0 -0)
📝 docs/administration/how_to_guides/organization_management/static/create_account.png (+0 -0)
📝 docs/administration/how_to_guides/organization_management/static/create_api_key.png (+0 -0)

...and 80 more files

📄 Description

Main Change

This PR changes our top level doc categories to match our new homepage design. Instead of:

how_to_guides:
-> ...
concepts:
-> ...

We instead have our docs in terms of product categories:

observability
-> concepts
-> how to guides
evaluation
-> concepts
-> how to guides
prompt engineering
-> concepts
-> how to guides
deployment
-> concepts
-> how to guides
administration
-> concepts
-> how to guides
-> pricing

Decisions Made

  1. Keep tutorials top level
  2. Keep self hosting top level
  3. Put pricing under administration
  4. Combine all conceptual docs under admin (resource hierarchy + usage + billing) into one page for simplicity
  5. Clicking on a product area defaults you into the conceptual docs
  6. Got rid of the doc card view such that the only place to see all how to guides laid out is by clicking "how to guides"

Still TODO

  • Put in all proper vercel.json redirects so this doesn't fuck over our docs links in langsmith

Thoughts for reviewers

I don't think this is the complete change. For example:

  1. I'd like to split eval how to guides further into (Experiment UI, Run Evaluations in Code (sections for SDK / REST API / etc)
  2. I'd like to move online eval into evaluation from monitoring

Not sure if people prefer incremental changes or big ones here.. I see arguments for both


🔄 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/479 **Author:** [@jakerachleff](https://github.com/jakerachleff) **Created:** 10/22/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `2024-10-22-site-reorg` --- ### 📝 Commits (10+) - [`42bb11d`](https://github.com/langchain-ai/langsmith-docs/commit/42bb11d1a93a7be599751e1877835f204f44e1d9) evaluation almost there - [`3aaa76b`](https://github.com/langchain-ai/langsmith-docs/commit/3aaa76b177d79437d726092a6910af7b052bdd56) evaluation working - [`7ff51e3`](https://github.com/langchain-ai/langsmith-docs/commit/7ff51e3e5aa1816e4682232766a42ae651d22c0a) observability concepts - [`1708e54`](https://github.com/langchain-ai/langsmith-docs/commit/1708e543e800b574bc4a8990bb93aa515e90a32d) moved tracing how tos - [`5040490`](https://github.com/langchain-ai/langsmith-docs/commit/5040490a01d3a6ea94ee45d294d6edc78e25a505) move monitoring how to guides - [`816d3f7`](https://github.com/langchain-ai/langsmith-docs/commit/816d3f753d8034dcf112a5112f1aea8673b8209e) observability and eval are moved completely - [`e685220`](https://github.com/langchain-ai/langsmith-docs/commit/e685220be64d17a7dd46f537c9678a31b7bd80bf) prompt engineering complete - [`03fb5f1`](https://github.com/langchain-ai/langsmith-docs/commit/03fb5f1f0ff87bf35e65508aaeda74c075618360) added administartion section to docs - [`0399e1f`](https://github.com/langchain-ai/langsmith-docs/commit/0399e1f2e9f9de758f2188395ad6c672d2b4c786) moved pricing under admin - [`e37a37a`](https://github.com/langchain-ai/langsmith-docs/commit/e37a37a9da586db4e446d909d7951e011c0b193a) remove indexes ### 📊 Changes **361 files changed** (+1087 additions, -1151 deletions) <details> <summary>View changed files</summary> ➕ `docs/administration/concepts/index.mdx` (+404 -0) 📝 `docs/administration/concepts/static/org_members_settings.png` (+0 -0) 📝 `docs/administration/concepts/static/org_settings_workspaces_tab.png` (+0 -0) 📝 `docs/administration/concepts/static/resource_tags.png` (+0 -0) 📝 `docs/administration/concepts/static/roles_tab_rbac.png` (+0 -0) 📝 `docs/administration/concepts/static/sample_workspace.png` (+0 -0) ➕ `docs/administration/how_to_guides/index.md` (+28 -0) 📝 `docs/administration/how_to_guides/organization_management/_category_.json` (+0 -0) 📝 `docs/administration/how_to_guides/organization_management/create_account_api_key.mdx` (+3 -3) ➕ `docs/administration/how_to_guides/organization_management/index.jsx` (+13 -0) 📝 `docs/administration/how_to_guides/organization_management/manage_organization_by_api.mdx` (+5 -5) 📝 `docs/administration/how_to_guides/organization_management/set_up_access_control.mdx` (+5 -5) 📝 `docs/administration/how_to_guides/organization_management/set_up_billing.mdx` (+4 -4) 📝 `docs/administration/how_to_guides/organization_management/set_up_organization.mdx` (+6 -6) 📝 `docs/administration/how_to_guides/organization_management/set_up_resource_tags.mdx` (+5 -5) 📝 `docs/administration/how_to_guides/organization_management/set_up_saml_sso.mdx` (+6 -6) 📝 `docs/administration/how_to_guides/organization_management/set_up_workspace.mdx` (+4 -4) 📝 `docs/administration/how_to_guides/organization_management/static/assign_role.png` (+0 -0) 📝 `docs/administration/how_to_guides/organization_management/static/create_account.png` (+0 -0) 📝 `docs/administration/how_to_guides/organization_management/static/create_api_key.png` (+0 -0) _...and 80 more files_ </details> ### 📄 Description ## Main Change This PR changes our top level doc categories to match our new homepage design. Instead of: ``` how_to_guides: -> ... concepts: -> ... ``` We instead have our docs in terms of product categories: ``` observability -> concepts -> how to guides evaluation -> concepts -> how to guides prompt engineering -> concepts -> how to guides deployment -> concepts -> how to guides administration -> concepts -> how to guides -> pricing ``` ## Decisions Made 1. Keep tutorials top level 2. Keep self hosting top level 3. Put pricing under administration 4. Combine all conceptual docs under admin (resource hierarchy + usage + billing) into one page for simplicity 5. Clicking on a product area defaults you into the conceptual docs 6. Got rid of the doc card view such that the only place to see all how to guides laid out is by clicking "how to guides" ## Still TODO - Put in all proper vercel.json redirects so this doesn't fuck over our docs links in langsmith ## Thoughts for reviewers I don't think this is the complete change. For example: 1. I'd like to split eval how to guides further into (Experiment UI, Run Evaluations in Code (sections for SDK / REST API / etc) 2. I'd like to move online eval into evaluation from monitoring Not sure if people prefer incremental changes or big ones here.. I see arguments for both --- <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.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langsmith-docs#536