Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(docs/.style/style-guide): fix self-violating examples #27849

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
nickvigilante merged 1 commit into from
Aug 4, 2026
Merged

docs(docs/.style/style-guide): fix self-violating examples #27849

Show file tree
Hide file tree
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
22 changes: 11 additions & 11 deletions docs/.style/style-guide/accessibility-and-inclusion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,31 +166,31 @@ Refer to UI elements by their label, not by their position on the screen.

**Do**:

> See the [Latin abbreviations rule](#latin-abbreviations) for the comma convention.
> Refer to the [Latin abbreviations rule](#latin-abbreviations) for the comma convention.
>
> Add a `<small>` caption after the image.
>
> Open the **Workspaces** sidebar to switch templates.

**Don't**:

> See the table below for the comma convention.
> Refer to the table below for the comma convention.
>
> Add a `<small>` caption underneath the image.
>
> Open the menu on the left to switch templates.

Common replacements:

| Avoid | Prefer |
|------------------------------|---------------------------------------------------------|
| see below | see the following section, see the `[Section](#anchor)` |
| see above | see the previous section, see earlier |
| top of the page | beginning of the page |
| bottom of the page | end of the page |
| the menu on the left | the **Sidebar** menu |
| the right side of the screen | the **Details** panel |
| scroll down | scroll to the `[Section](#anchor)`, scroll to the end |
| Avoid | Prefer |
|------------------------------|-------------------------------------------------------------------|
| see below | refer to the following section, refer to the `[Section](#anchor)` |
| see above | refer to the previous section, as described earlier |
| top of the page | beginning of the page |
| bottom of the page | end of the page |
| the menu on the left | the **Sidebar** menu |
| the right side of the screen | the **Details** panel |
| scroll down | scroll to the `[Section](#anchor)`, scroll to the end |

The rule covers prose.
Idiomatic stack metaphors like "built on top of Terraform" and phrasal verbs like "set up", "back up", "log in", and "shut down" aren't directional and stay as-is.
Expand Down
17 changes: 14 additions & 3 deletions docs/.style/style-guide/formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,28 @@ What doesn't get its own line:
- Source inside fenced code blocks, where the language's own conventions apply.
- Table rows, which are governed by `markdown-table-formatter`.

The examples show Markdown source, not rendered output, because the convention governs how the source lines are laid out.

**Do**:

> The Coder agent connects to the workspace, opens a Tailscale tunnel, and forwards SSH and IDE traffic over the tunnel.
```md
The Coder agent connects to the workspace, opens a Tailscale tunnel, and forwards SSH and IDE traffic over the tunnel.
```

**Don't** (mid-sentence clause breaks):

> The Coder agent connects to the workspace, opens a Tailscale tunnel, and forwards SSH and IDE traffic over the tunnel.
```md
The Coder agent connects to the workspace,
opens a Tailscale tunnel,
and forwards SSH and IDE traffic over the tunnel.
```

**Don't** (fixed column wrap):

> The Coder agent connects to the workspace, opens a Tailscale tunnel, and forwards SSH and IDE traffic over the tunnel.
```md
The Coder agent connects to the workspace, opens a Tailscale
tunnel, and forwards SSH and IDE traffic over the tunnel.
```

Both **Don't** versions add noise to the source and produce diff churn on small edits.

Expand Down
Loading