Skip to content

docs: uppercase mixed-case GitHub-style callout markers [DOCS-681] #28304

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 19, 2026
Merged

docs: uppercase mixed-case GitHub-style callout markers [DOCS-681] #28304

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
2 changes: 1 addition & 1 deletion docs/install/rancher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ kubectl create secret generic coder-db-url -n coder \
--from-literal=url="postgres://coder:[email protected]:5432/coder?sslmode=disable"
```

> [!Important]
> [!IMPORTANT]
> If you're using a managed PostgreSQL service, replace the connection URL with your specific database credentials.

## Install Coder through the Rancher UI
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/shared-workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- A workspace can be owned by a group of users for QA, on-call rotations, or shared staging.
- AI workflows where an agent prepares a workspace and a developer takes over to review or finalize the work (ex. with [Coder Tasks](https://coder.com/docs/ai-coder/tasks).)

## Getting Started

Check warning on line 19 in docs/user-guides/shared-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Getting'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Workspaces can be shared through either the Coder CLI or UI.

Expand All @@ -40,7 +40,7 @@
- `coder sharing remove <workspace> --group contractor`
- Workspace is no longer shared with the group `contractor`.

> [!Important]
> [!IMPORTANT]
> The workspace must be restarted for the user or group removal to take effect.

To show who a workspace is shared with:
Expand All @@ -56,7 +56,7 @@

### UI

#### Sharing your Workspace

Check warning on line 59 in docs/user-guides/shared-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Sharing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. Open a workspace that you own.

Expand All @@ -73,13 +73,13 @@
- Neither role allows for the user to delete the workspace.
- After removing a user/group, a workspace restart is required for the removal to take effect.

#### Using a shared workspace

Check warning on line 76 in docs/user-guides/shared-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Using'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Once a workspace is shared, you can find the shared workspace by filtering for "Shared" in the Workspaces page.

![Sharing with a user or group](../images/user-guides/workspace-sharing-shared-view.png)

#### Accessing workspace apps in shared workspaces

Check warning on line 82 in docs/user-guides/shared-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Accessing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Sharing a workspace grants SSH and terminal access to other users. However,
workspace apps like code-server may return a **404 page** for non-owners
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@

Or, you can configure plain SSH on your client below.

> [!Note]
> [!NOTE]
> The `coder ssh` command does not have full parity with the standard
> SSH command. For users who need the full functionality of SSH, use the
> configuration method below.

### Running remote commands with quoting

Check warning on line 46 in docs/user-guides/workspace-access/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Arguments after `--` are joined with spaces into a single command
string before being sent to the workspace agent (per
Expand Down
Loading