Skip to content

Commit 413f46c

Browse files
jakerachleffdqbd
authored andcommitted
feat: docs organized by area with better how to sections (langchain-ai#488)
Organize docs by product area, and organize how to guides to have some structure
1 parent c61716f commit 413f46c

File tree

423 files changed

+1276
-1200
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

423 files changed

+1276
-1200
lines changed

docs/administration/concepts/index.mdx

Lines changed: 404 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Administration how-to guides
2+
3+
Step-by-step guides that cover key tasks and operations in LangSmith.
4+
5+
## Organization Management
6+
7+
See the following guides to set up your LangSmith account.
8+
9+
- [Create an account and API key](./how_to_guides/organization_management/create_account_api_key)
10+
- [Set up an organization](./how_to_guides/organization_management/set_up_organization)
11+
- [Create an organization](./how_to_guides/organization_management/set_up_organization#create-an-organization)
12+
- [Manage and navigate workspaces](./how_to_guides/organization_management/set_up_organization#manage-and-navigate-workspaces)
13+
- [Manage users](./how_to_guides/organization_management/set_up_organization#manage-users)
14+
- [Manage your organization using the API](./how_to_guides/organization_management/manage_organization_by_api)
15+
- [Set up a workspace](./how_to_guides/organization_management/set_up_workspace)
16+
- [Create a workspace](./how_to_guides/organization_management/set_up_workspace#create-a-workspace)
17+
- [Manage users](./how_to_guides/organization_management/set_up_workspace#manage-users)
18+
- [Configure workspace settings](./how_to_guides/organization_management/set_up_workspace#configure-workspace-settings)
19+
- [Set up billing](./how_to_guides/organization_management/set_up_billing)
20+
- [Update invoice email, tax id and, business information](./how_to_guides/organization_management/update_business_info)
21+
- [Set up access control (enterprise only)](./how_to_guides/organization_management/set_up_access_control)
22+
- [Create a role](./how_to_guides/organization_management/set_up_access_control#create-a-role)
23+
- [Assign a role to a user](./how_to_guides/organization_management/set_up_access_control#assign-a-role-to-a-user)
24+
- [Set up resource tags](./how_to_guides/organization_management/set_up_resource_tags)
25+
- [Create a tag](./how_to_guides/organization_management/set_up_resource_tags#create-a-tag)
26+
- [Assign a tag to a resource](./how_to_guides/organization_management/set_up_resource_tags#assign-a-tag-to-a-resource)
27+
- [Delete a tag](./how_to_guides/organization_management/set_up_resource_tags#delete-a-tag)
28+
- [Filter resources by tags](./how_to_guides/organization_management/set_up_resource_tags#filter-resources-by-tags)

docs/how_to_guides/setup/create_account_api_key.mdx renamed to docs/administration/how_to_guides/organization_management/create_account_api_key.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";
1111
To get started with LangSmith, you need to create an account. You can sign up for a free account <RegionalUrl text='here'/>.
1212
We support logging in with Google, GitHub, Discord, and email.
1313

14-
![](../static/create_account.png)
14+
![](./static/create_account.png)
1515

1616
## API keys
1717

1818
LangSmith supports two types of API keys: Service Keys and Personal Access Tokens.
1919
Both types of tokens can be used to authenticate requests to the LangSmith API, but they have different use cases.
2020

21-
Read more about the differences between Service Keys and Personal Access Tokens under [admin concepts](../../concepts/admin/admin.mdx)
21+
Read more about the differences between Service Keys and Personal Access Tokens under [admin concepts](../../concepts)
2222

2323
## Create an API key
2424

@@ -30,7 +30,7 @@ To create either type of API key head to the <RegionalUrl text='Settings page' s
3030
The API key will be shown only once, so make sure to copy it and store it in a safe place.
3131
:::
3232

33-
![](../static/create_api_key.png)
33+
![](./static/create_api_key.png)
3434

3535
## Configure the SDK
3636

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import React, { useEffect } from "react";
2+
import { useHistory } from "@docusaurus/router";
3+
4+
export default function ChildPage() {
5+
const history = useHistory();
6+
7+
useEffect(() => {
8+
// Redirect to parent page on load
9+
history.push("../how_to_guides");
10+
}, [history]);
11+
12+
return null; // No need to render anything since we're redirecting
13+
}

docs/how_to_guides/setup/manage_organization_by_api.mdx renamed to docs/administration/how_to_guides/organization_management/manage_organization_by_api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ LangSmith's API supports programmatic access via API key to all of the actions a
88

99
Before diving into this content, it might be helpful to read the following:
1010

11-
- [Conceptual guide on organizations and workspaces](../../concepts/admin)
12-
- [Organization setup how-to guild](../../how_to_guides/setup/set_up_organization.mdx)
11+
- [Conceptual guide on organizations and workspaces](../../concepts)
12+
- [Organization setup how-to guild](./set_up_organization.mdx)
1313

1414
:::
1515

1616
:::note
1717
There are a few limitations that will be lifted soon:
1818

1919
- The LangSmith SDKs do not support these organization management actions yet.
20-
- [Service Keys](../../concepts/admin/admin.mdx#api-keys) don't have access to newly-added workspaces yet (we're adding support soon). We recommend using a PAT of an Organization Admin for now, which by default has the required permissions for these actions.
20+
- [Service Keys](../../concepts#api-keys) don't have access to newly-added workspaces yet (we're adding support soon). We recommend using a PAT of an Organization Admin for now, which by default has the required permissions for these actions.
2121

2222
:::
2323

@@ -120,7 +120,7 @@ Workspace level:
120120
/>
121121

122122
:::note
123-
These params should be omitted: `read_only` (deprecated), `password` and `full_name` ([basic auth](../../reference/authentication_authorization/authentication_methods.mdx) only)
123+
These params should be omitted: `read_only` (deprecated), `password` and `full_name` ([basic auth](/reference/authentication_authorization/authentication_methods.mdx) only)
124124
:::
125125

126126
## API Keys
@@ -146,7 +146,7 @@ If the header is not present, operations will default to the workspace the API k
146146
These endpoints are user-scoped and require a logged-in user's JWT, so they should only be executed through the UI.
147147

148148
- `/api-key/current` endpoints: these are related a user's PATs
149-
- `/sso/email-verification/send` (Cloud-only): this endpoint is related to [SAML SSO](../../how_to_guides/setup/set_up_saml_sso.mdx)
149+
- `/sso/email-verification/send` (Cloud-only): this endpoint is related to [SAML SSO](./set_up_saml_sso.mdx)
150150

151151
## Sample Code
152152

docs/how_to_guides/setup/set_up_access_control.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_access_control.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";
44

55
:::note
66
RBAC (Role-Based Access Control) is a feature that is only available to Enterprise customers. If you are interested in this feature, please contact our sales team at [email protected]
7-
Other plans default to using the Admin role for all users. Read more about roles under [admin concepts](../../concepts/admin/admin.mdx)
7+
Other plans default to using the Admin role for all users. Read more about roles under [admin concepts](../../concepts)
88
:::
99

1010
:::tip Recommended Reading
1111

1212
Before diving into this content, it might be helpful to read the following:
1313

14-
- [Conceptual guide on organizations and workspaces](../../concepts/admin)
14+
- [Conceptual guide on organizations and workspaces](../../concepts)
1515

1616
:::
1717

@@ -32,7 +32,7 @@ To create a role, navigate to the `Roles` tab in the `Members and roles` section
3232

3333
Click on the `Create Role` button to create a new role. You should see a form like the one below:
3434

35-
![Create Role](../static/create_role.png)
35+
![Create Role](./static/create_role.png)
3636

3737
Assign permissions for the different LangSmith resources that you want to control access to.
3838

@@ -42,8 +42,8 @@ Once you have your roles set up, you can assign them to users. To assign a role
4242

4343
Each user will have a `Role` dropdown that you can use to assign a role to them.
4444

45-
![Assign Role](../static/assign_role.png)
45+
![Assign Role](./static/assign_role.png)
4646

4747
You can also invite new users with a given role.
4848

49-
![Invite User](../static/invite_user.png)
49+
![Invite User](./static/invite_user.png)

docs/how_to_guides/setup/set_up_billing.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_billing.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ add a credit card on the Plans and Billing page as follows:
2525

2626
### 1. Click `Set up Billing`
2727

28-
![](../static/free_tier_billing_page.png)
28+
![](./static/free_tier_billing_page.png)
2929

3030
### 2. Add your credit card info
3131

@@ -49,14 +49,14 @@ If you are a startup building with AI, please instead click `Apply Now` on our S
4949
eligible for discounted prices and a generous free, monthly trace allotment.
5050
:::
5151

52-
![](../static/new_org_billing_page.png)
52+
![](./static/new_org_billing_page.png)
5353

5454
### 2. Review your existing members
5555

5656
Before subscribing, LangSmith lets you remove any added users that you would not
5757
like to be charged for.
5858

59-
![](../static/new_org_manage_spend.png)
59+
![](./static/new_org_manage_spend.png)
6060

6161
### 3. Enter your credit card info
6262

@@ -78,7 +78,7 @@ rate limited to a maximum of 5,000 traces per month.
7878

7979
### 2. Click `Set up Billing`
8080

81-
![](../static/setup_billing_legacy.png)
81+
![](./static/setup_billing_legacy.png)
8282

8383
### 3. Enter your credit card info
8484

docs/how_to_guides/setup/set_up_organization.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_organization.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";
1010

1111
Before diving into this content, it might be helpful to read the following:
1212

13-
- [Conceptual guide on organizations and workspaces](../../concepts/admin)
13+
- [Conceptual guide on organizations and workspaces](../../concepts)
1414

1515
:::
1616

1717
:::note
18-
If you're interested in managing your organization and workspaces programmatically, see [this hot-to guide](../../how_to_guides/setup/manage_organization_by_api.mdx).
18+
If you're interested in managing your organization and workspaces programmatically, see [this how-to guide](./manage_organization_by_api.mdx).
1919
:::
2020

2121
## Create an organization
@@ -25,14 +25,14 @@ When you log in for the first time, a personal organization will be created for
2525
To do this, head to the <RegionalUrl text='Settings page' suffix='/settings'/> and click **Create Organization**.
2626
Shared organizations require a credit card before they can be used. You will need to [set up billing](./set_up_billing) to proceed.
2727

28-
![](../static/create_organization.png)
28+
![](./static/create_organization.png)
2929

3030
## Manage and navigate workspaces
3131

3232
Once you've subscribed to a plan that allows for multiple users per organization, you can [set up workspaces](./set_up_workspace) to collaborate more effectively and isolate LangSmith resources between different groups of users.
3333
To navigate between workspaces and access the resources within each workspace (trace projects, annotation queues, etc.), select the desired workspace from the picker in the top left:
3434

35-
![](../static/select_workspace.png)
35+
![](./static/select_workspace.png)
3636

3737
## Manage users
3838

@@ -43,7 +43,7 @@ Here you can
4343
- Edit a user's organization role
4444
- Remove users from your organization
4545

46-
![](../static/organization_members_and_roles.png)
46+
![](./static/organization_members_and_roles.png)
4747

4848
Organizations on the Enterprise plan may set up custom workspace roles in the `Roles` tab here. See the [access control setup guide](./set_up_access_control.mdx) for more details.
4949

@@ -59,4 +59,4 @@ The `Organization User` role is only available in organizations on plans with mu
5959
Custom organization-scoped roles are not available yet.
6060
:::
6161

62-
See [this conceptual guide](../../concepts/admin#organization-roles) for a full list of permissions associated with each role.
62+
See [this conceptual guide](../../concepts#organization-roles) for a full list of permissions associated with each role.

docs/how_to_guides/setup/set_up_resource_tags.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_resource_tags.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Before diving into this content, it might be helpful to read the following:
66

7-
- [Conceptual guide on organizations and workspaces](../../concepts/admin)
7+
- [Conceptual guide on organizations and workspaces](../../concepts)
88

99
:::
1010

@@ -22,7 +22,7 @@ Here, you'll be able to see the existing tag values, grouped by key. Two keys `A
2222

2323
To create a new tag, click on the "New Tag" button. You'll be prompted to enter a key and a value for the tag. Note that you can use an existing key or create a new one.
2424

25-
![](../static/resource_tags/create_tag.png)
25+
![](./static/resource_tags/create_tag.png)
2626

2727
## Assign a tag to a resource
2828

@@ -34,7 +34,7 @@ You can only tag workspace-scoped resources with resource tags. This includes Tr
3434

3535
You can also assign tags to resources from the resource's detail page. Click on the Resource tags button to open up the tag panel and assign tags.
3636

37-
![](../static/resource_tags/assign_tag.png)
37+
![](./static/resource_tags/assign_tag.png)
3838

3939
To un-assign a tag from a resource, click on the Trash icon next to the tag, both in the tag panel and the resource tag panel.
4040

@@ -44,7 +44,7 @@ You can delete either a key or a value of a tag from the [workspace settings pag
4444

4545
Note that if you delete a key, all values associated with that key will also be deleted. When you delete a value, you will lose all associations between that value and resources.
4646

47-
![](../static/resource_tags/delete_tag.png)
47+
![](./static/resource_tags/delete_tag.png)
4848

4949
## Filter resources by tags
5050

@@ -56,4 +56,4 @@ In the homepage, you can see updated counts for resources based on the tags you'
5656

5757
As you navigate through the different product surfaces, you will _only_ see resources that match the tags you've selected. At any time, you can clear the tags to see all resources in the workspace or select different tags to filter by.
5858

59-
![](../static/resource_tags/filter_by_tags.png)
59+
![](./static/resource_tags/filter_by_tags.png)

docs/how_to_guides/setup/set_up_saml_sso.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_saml_sso.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Single Sign-On (SSO) functionality is available for Enterprise customers to acce
77
LangSmith's SSO configuration is built using the SAML (Security Assertion Markup Language) 2.0 standard. SAML 2.0 enables connecting an Identity Provider (IdP) to your organization for an easier, more secure login experience.
88

99
:::note
10-
SAML SSO is available for organizations on the [Enterprise plan](../../pricing.mdx). Please [contact sales](https://www.langchain.com/contact-sales) to learn more.
10+
SAML SSO is available for organizations on the [Enterprise plan](../../pricing). Please [contact sales](https://www.langchain.com/contact-sales) to learn more.
1111
:::
1212

1313
## What is SAML SSO?
@@ -26,7 +26,7 @@ SSO services permit a user to use one set of credentials (for example, a name or
2626

2727
- Your organization must be on an Enterprise plan
2828
- Your Identity Provider (IdP) must support the SAML 2.0 standard
29-
- Only [Organization Admins](../../concepts/admin#organization-roles) can configure SAML SSO
29+
- Only [Organization Admins](../../concepts#organization-roles) can configure SAML SSO
3030

3131
### Initial configuration
3232

@@ -61,15 +61,15 @@ The URLs are different for the US and EU. Please make sure to select your region
6161
LangSmith supports Just-in-Time provisioning when using SAML SSO. This allows someone signing in via SAML SSO to join the organization and selected workspaces automatically as a member.
6262

6363
:::note
64-
JIT provisioning only runs for new users i.e. users who do not already have access to the organization with the same email address via a [different login method](../../reference/authentication_authorization/authentication_methods.mdx#cloud)
64+
JIT provisioning only runs for new users i.e. users who do not already have access to the organization with the same email address via a [different login method](/reference/authentication_authorization/authentication_methods.mdx#cloud)
6565
:::
6666

6767
## Login methods and access
6868

69-
Once you have completed your configuration of SAML SSO for your organization, users will be able to login via SAML SSO in addition to [other login methods](../../reference/authentication_authorization/authentication_methods.mdx#cloud) such as username/password and Google Authentication.
69+
Once you have completed your configuration of SAML SSO for your organization, users will be able to login via SAML SSO in addition to [other login methods](/reference/authentication_authorization/authentication_methods.mdx#cloud) such as username/password and Google Authentication.
7070

7171
- When logged in via SAML SSO, users can only access the corresponding organization with SAML SSO configured.
72-
- Users with SAML SSO as their only login method do not have [personal organizations](../../concepts/admin/admin.mdx#organizations)
72+
- Users with SAML SSO as their only login method do not have [personal organizations](../../concepts#organizations)
7373
- When logged in via any other method, users can access the organization with SAML SSO configured along with any other organizations they are a part of
7474

7575
## Enforce SAML SSO only
@@ -93,7 +93,7 @@ If you have issues setting up SAML SSO, please reach out to [[email protected]
9393

9494
Some identity providers retain the original `User ID` through an email change while others do not, so we recommend that you follow these steps to avoid duplicate users in LangSmith:
9595

96-
1. Remove the user from the organization (see [here](../setup/set_up_organization.mdx#manage-users))
96+
1. Remove the user from the organization (see [here](./set_up_organization.mdx#manage-users))
9797
1. Change their email address in the IdP
9898
1. Have them login to LangSmith again via SAML SSO - this will trigger the usual [JIT provisioning](#just-in-time-jit-provisioning) flow with their new email address
9999

docs/how_to_guides/setup/set_up_workspace.mdx renamed to docs/administration/how_to_guides/organization_management/set_up_workspace.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ import { RegionalUrl } from "@site/src/components/RegionalUrls";
1010

1111
Before diving into this content, it might be helpful to read the following:
1212

13-
- [Conceptual guide on organizations and workspaces](../../concepts/admin)
13+
- [Conceptual guide on organizations and workspaces](../../concepts)
1414

1515
:::
1616

17-
When you log in for the first time, a default [workspace](../../concepts/admin/admin.mdx#workspaces) will be created for you automatically in your [personal organization](./set_up_organization#personal-vs-shared-organizations).
17+
When you log in for the first time, a default [workspace](../../concepts#workspaces) will be created for you automatically in your [personal organization](./set_up_organization#personal-vs-shared-organizations).
1818
Workspaces are often used to separate resources between different teams or business units, ensuring clear trust boundaries between them. Within each workspace, Role-Based Access Control (RBAC) is implemented to manage permissions and access levels, ensuring that users only have access to the resources and settings necessary for their role. Most LangSmith activity happens in the context of a workspace, each of which has its own settings and access controls.
1919

2020
To organize resources _within_ a workspace, you can use [resource tags](./set_up_resource_tags).
@@ -24,7 +24,7 @@ To organize resources _within_ a workspace, you can use [resource tags](./set_up
2424
To create a new workspace, head to the <RegionalUrl text='Settings page' suffix='/settings'/> `Workspaces` tab in your shared organization and click **Add Workspace**.
2525
Once your workspace has been created, you can manage its members and other configuration by selecting it on this page.
2626

27-
![](../static/create_workspace.png)
27+
![](./static/create_workspace.png)
2828

2929
:::note
3030
Different plans have different limits placed on the number of workspaces that can be used in an organization.
@@ -44,4 +44,4 @@ Users may also be invited directly to one or more workspaces when they are [invi
4444

4545
Workspace configuration exists in the <RegionalUrl text='workspace settings page' suffix='/settings/workspaces'/> tab. Select the workspace to configure and then the desired configuration sub-tab. The example below shows the `API keys`, and other configuration options including secrets, models, and shared URLs are available here as well.
4646

47-
![](../static/workspace_settings.png)
47+
![](./static/workspace_settings.png)

docs/how_to_guides/setup/update_business_info.mdx renamed to docs/administration/how_to_guides/organization_management/update_business_info.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Business information, tax id and invoice email can only be updated for the plus
2020

2121
## Update invoice email
2222

23-
![](../static/update_invoice_email.png)
23+
![](./static/update_invoice_email.png)
2424

2525
To update the email address where your invoices are sent, follow these steps:
2626

@@ -37,7 +37,7 @@ This ensures that all future invoices will be sent to the updated email address.
3737
In certain jurisdictions, LangSmith is required to collect sales tax. If you are a business, providing your Tax ID may qualify you for a sales tax exemption.
3838
:::
3939

40-
![](../static/update_business_info.png)
40+
![](./static/update_business_info.png)
4141

4242
To update your organization's business information, follow these steps:
4343

0 commit comments

Comments
 (0)