Skip to content

[Style Guide] Updated links rules #17425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2024
Merged

[Style Guide] Updated links rules #17425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/content/docs/style-guide/formatting/structure/links.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
---
pcx_content_type: concept
title: Links

---

Follow these guidelines for link text.

## Create links

Use the path to the product when creating a link.

- **Do**:
- `This is a link for Magic WAN's [Get started](/magic-wan/get-started/)`
- **Don't:**
- `This is a link for Magic WAN's [Get started](https://developers.cloudflare.com/magic-wan/get-started/)`

**Also not supported:**

- Relative links: ``A link to [`DurableObjectNamespace::get`](./namespace)``
- Using the file extension in links: `This is a link for Magic WAN's [Get started](/magic-wan/get-started.mdx/)`

## Standard text

As much as possible, use text that follows one of these patterns:
Expand Down Expand Up @@ -43,4 +56,3 @@ When directing users to the Cloudflare dashboard, use the following convention:
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
2. Go to **DNS** > **Records**.
```

Loading