Skip to content

Commit e7a321a

Browse files
committed
docs(sim-links): tighten the Sim Links page
1 parent f713c73 commit e7a321a

1 file changed

Lines changed: 16 additions & 22 deletions

File tree

‎apps/docs/content/docs/search/sim-links.mdx‎

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,56 @@ title: Sim Links
33
description: Short sim/ links that take everyone in your organization to the right page
44
---
55

6-
Sim Links are short, memorable names for the pages your team opens often, like `sim/handbook` for the employee handbook or `sim/okta` for your sign-in portal. Anyone in the organization can open them, with or without a Search seat. They work like go links in other tools.
6+
Sim Links are short names for pages your team opens often, like `sim/handbook` or `sim/okta`. Every member of your organization can use them, with or without a Search seat.
77

8-
Open **Sim Links** in the organization sidebar to see every link in your organization, with who created it and when it last changed. Search by name, destination, or description, and use **Sort → Opens** to see the 50 links your team opens most.
8+
Open **Sim Links** in the organization sidebar to see your organization's links. Search by name, destination, or description, or use **Sort → Opens** to see the most used links.
99

1010
## Open a link
1111

12-
Go to `https://www.sim.ai/sim/<name>`, for example `https://www.sim.ai/sim/handbook`. On a self-hosted deployment, use your Sim address instead. Sim sends you to the link's destination. If you aren't signed in, Sim asks you to sign in first, then continues to the link.
12+
Go to `https://www.sim.ai/sim/<name>`, for example `https://www.sim.ai/sim/handbook`. On a self-hosted deployment, use your Sim address. If you aren't signed in, Sim asks you to sign in first.
1313

14-
Names ignore case and punctuation, so `sim/Team-Handbook`, `sim/team_handbook`, and `sim/teamhandbook` all open the same link. The destination still applies its own permissions.
15-
16-
If nobody has created the link yet, Sim offers to create it with that name.
14+
Names ignore case and punctuation, so `sim/Team-Handbook` and `sim/teamhandbook` open the same link. If a link doesn't exist yet, Sim offers to create it.
1715

1816
## Open links from the address bar
1917

20-
Add Sim as a site search shortcut in Chrome so you can type `sim handbook` instead of the full address:
18+
Add Sim as a Chrome site search shortcut to type `sim handbook` instead:
2119

2220
1. Open Chrome **Settings → Search engine → Manage search engines and site search**.
2321
2. Next to **Site search**, select **Add**.
2422
3. Enter `Sim` as the name, `sim` as the shortcut, and `https://www.sim.ai/sim/%s` as the URL.
2523

26-
Type `sim`, press **Space** or **Tab**, then type a link name such as `handbook` or `jira/123` and press **Enter**.
27-
28-
Chrome administrators can add this shortcut for everyone with the `SiteSearchSettings` policy, using the same shortcut and URL.
24+
Type `sim`, press **Space**, then type a link name and press **Enter**. Chrome administrators can add the shortcut for everyone with the `SiteSearchSettings` policy.
2925

3026
## Create a link
3127

3228
1. Open **Sim Links** and select **New link**.
33-
2. Enter the **Destination URL**, a full `https://` or `http://` address.
34-
3. Enter a **Name**. Use letters, numbers, and `. : @ & ~ - _`.
35-
4. Optionally add a **Description** so teammates know what the link is for.
36-
5. Select **Create**.
29+
2. Enter the **Destination URL** and a **Name**. Names can use letters, numbers, and `. : @ & ~ - _`.
30+
3. Optionally add a **Description**, then select **Create**.
3731

38-
Right-click a link and select **Copy link** to share it.
32+
To share a link, right-click it and select **Copy link**.
3933

4034
## Add values to a link
4135

42-
Anything after the name is added to the destination. If `sim/docs` opens `https://docs.example.com`, then `sim/docs/billing/invoices` opens `https://docs.example.com/billing/invoices`.
36+
Anything after the name is added to the destination: if `sim/docs` opens `https://docs.example.com`, then `sim/docs/billing` opens `https://docs.example.com/billing`.
4337

44-
To place a value somewhere else, put `{*}` in the destination URL:
38+
To place a value elsewhere, put `{*}` in the destination URL:
4539

4640
| Destination URL | You open | Sim opens |
4741
| --- | --- | --- |
4842
| `https://jira.example.com/browse/PROD-{*}` | `sim/jira/123` | `https://jira.example.com/browse/PROD-123` |
4943
| `https://wiki.example.com/search?q={*}` | `sim/wiki/expense policy` | `https://wiki.example.com/search?q=expense%20policy` |
5044
| `https://github.com/acme/{*}/issues/{*}` | `sim/issues/api/42` | `https://github.com/acme/api/issues/42` |
5145

52-
Each value fills the next `{*}` in order, and the last `{*}` takes everything that remains. A link with `{*}` can also have a **Default destination** on the same site, which opens when you use the link without a value. `{*}` can't replace the domain, and values can't be `.` or `..`.
46+
Values fill each `{*}` in order, and the last `{*}` takes the rest. A link with `{*}` can set a **Default destination** on the same site for when no value is given. `{*}` can't replace the domain.
5347

5448
## Control access
5549

56-
The **Access** section of a link has two options. Only the link's creator and organization admins can change them:
50+
By default, any member can edit or delete a link. The link's creator and organization admins can change two options under **Access**:
5751

58-
- **Hide from the Sim Links page for everyone except you and admins**: the link is listed only for its creator and organization admins. Anyone who knows the name can still open it.
59-
- **Restrict editing to you and admins**: only the creator and organization admins can edit or delete the link. Everyone can still open it.
52+
- **Unlisted**: only the creator and admins see the link on the Sim Links page. Anyone with the name can still open it.
53+
- **Restricted**: only the creator and admins can edit or delete the link.
6054

61-
The **Access** column on the Sim Links page shows **Unlisted** or **Restricted** for links that use them. Without either option, any member can edit or delete a link. Creating, editing, and deleting links is recorded in your organization's [audit logs](/platform/enterprise/audit-logs).
55+
Changes to links are recorded in your organization's [audit logs](/platform/enterprise/audit-logs).
6256

6357
## Related docs
6458

0 commit comments

Comments
 (0)