Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/.style/styles/Coder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Planned coverage:
- Em-dash and en-dash mirror in Vale
- Product-voice rules

## Authoring a new rule
## Author a new rule

1. Write a YAML file under this directory.
Name it after the rule's intent, for example `InclusiveLanguage.yml` or `ProductVoice.yml`.
Expand Down
2 changes: 1 addition & 1 deletion docs/ai-governance/ai-gateway/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
## Data Retention

AI Gateway records prompts, token usage, tool invocations, and model reasoning for auditing and monitoring purposes.
By default, this data is retained for **60 days**.
By default, this data is retained for **60 days**.

Configure retention using `--ai-gateway-retention` or `CODER_AI_GATEWAY_RETENTION`:

Expand Down Expand Up @@ -222,7 +222,7 @@
- **Session grouping degrades** for clients that don't send their own session ID.
Coder groups those interceptions into threads by correlating recorded tool calls, so without tool usage records each interception becomes its own session.
The grouping is stored when the row is written, so it can't be recovered later by re-enabling the option.
- **Sessions pages are largely empty**, since there is no prompt, tool call or reasoning content to show.

Check notice on line 225 in docs/ai-governance/ai-gateway/setup.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'because, after' instead of 'since'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
- **Prompt and tool call telemetry report zero**.
- **The audit trail of what was asked is gone**, including for incident review.

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@

Learn more about how to find the repository URL in the [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).

2. Choose the folder to which VS Code should clone the repo.

Check notice on line 298 in docs/get-started/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'must, recommend' instead of 'should'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.

It will be in its own directory within this folder.

Expand Down Expand Up @@ -330,7 +330,7 @@

The Quickstart template is a starting point.
[Customize your template](./customize-your-template/index.md) walks you through adding a language, installing your own command-line tools, and cloning private repositories.
Each task takes about 10 minutes.
Each task takes about 10 minutes.

To carry your shell and editor settings into every workspace without editing the template, use [dotfiles](../workspaces/workspace-dotfiles.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,13 +194,13 @@
- **User and system**: authenticated user details, organization memberships, and tar uploads

The full, authoritative set of tools, including their names, descriptions, and arguments, is defined in Coder's [`toolsdk` package](../codersdk/toolsdk/toolsdk.go).
Refer to it for the current list, since the available tools can change between releases.

Check notice on line 197 in docs/mcp-server.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'because, after' instead of 'since'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.

The workspace file and command tools (`coder_workspace_read_file`, `coder_workspace_write_file`, `coder_workspace_edit_files`, `coder_workspace_execute`, and the `coder_workspace_process_*` tools) share their arguments and result formats with the matching [Coder Agents](./coder-agents/index.md) tools, with these differences:

- Each tool takes a `workspace` argument that selects the workspace to act on.
- Invalid arguments and workspace agent errors are returned as MCP tool errors.
- A single call waits at most 5 minutes.
- A single call waits at most 5 minutes.
Run longer commands with `run_in_background` and check on them with `coder_workspace_process_output`.
- Commands started through MCP are separate from Coder Agents chat processes, but anyone with SSH access to the workspace can list and signal them.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/feature-stages.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
Replicas that run an earlier version ignore rules and use their startup `--experiments` list.
Every replica also falls back to its own startup list for experiments without a rule or with `inherit`, so give all replicas the same `--experiments` value.

The dashboard fetches the enabled experiments again when a page loads, when the browser window regains focus, and when the connection is restored, if its copy is more than 60 seconds old.
The dashboard fetches the enabled experiments again when a page loads, when the browser window regains focus, and when the connection is restored, if its copy is more than 60 seconds old.
It doesn't refresh on a timer, so a tab that stays focused can show an out-of-date view.
The server applies the current rule to each request regardless of what the dashboard shows.

Expand Down Expand Up @@ -163,8 +163,8 @@
They might contain minor bugs, but are generally ready for use.

Beta features are often ready for general availability within two-three releases.
You should test beta features in staging environments.

Check notice on line 166 in docs/reference/feature-stages.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'must, recommend' instead of 'should'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
You can use beta features in production, but should set expectations and inform users that some features might be incomplete.

Check notice on line 167 in docs/reference/feature-stages.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'must, recommend' instead of 'should'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.

We keep documentation about beta features up-to-date with the latest information, including planned features, limitations, and workarounds.
If you encounter an issue, contact your [Coder account team](https://coder.com/contact), reach out on [Discord](https://discord.gg/coder), or create a [GitHub issues](https://github.com/coder/coder/issues) if there isn't one already.
Expand All @@ -191,7 +191,7 @@
For support, consult our knowledgeable and growing community on [Discord](https://discord.gg/coder), or create a [GitHub issue](https://github.com/coder/coder/issues) if one doesn't exist already.
Customers with a valid Coder license, can submit a support request or contact your [account team](https://coder.com/contact).

We intend [Coder documentation](https://github.com/coder/coder/blob/main/contributing/documentation.md) to be the [single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth) and all features should have some form of complete documentation that outlines how to use or implement a feature.

Check notice on line 194 in docs/reference/feature-stages.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'must, recommend' instead of 'should'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
If you discover an error or if you have a suggestion that could improve the documentation, [submit a GitHub issue](https://github.com/coder/internal/issues/new?title=request%28docs%29%3A+request+title+here&labels=["customer-feedback","docs"]&body=please+enter+your+request+here).

Some GA features can be disabled for air-gapped deployments.
Expand Down
6 changes: 4 additions & 2 deletions docs/templates/extending-templates/docker-in-workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,10 +376,11 @@
Without extra configuration, Podman falls back to `fuse-overlayfs`, which requires the `/dev/fuse` device and the smarter-device-manager setup above.
On nodes with kernel 5.13 or later, you can skip the FUSE device entirely:

1. Put the Podman graph root on a real filesystem such as ext4 or xfs.

Check warning on line 379 in docs/templates/extending-templates/docker-in-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.StepLength

This step's instruction has more than 20 words. Shorten it, split the step, or move the explanation to a paragraph below the instruction. Refer to procedural-writing.md#keep-steps-short.
If your template mounts a persistent volume at `/home/coder`, like the `kubernetes` starter, the default graph root already qualifies and keeps images across workspace restarts.
For ephemeral workspaces, mount an `emptyDir` volume at `/home/coder/.local/share/containers` instead; pulled images and build cache are lost when the workspace stops.
For ephemeral workspaces, mount an `emptyDir` volume at `/home/coder/.local/share/containers` instead.
Pulled images and build cache are lost when the workspace stops.
1. Clear the `mount_program` setting, because some Podman images pin it to `fuse-overlayfs` in `/etc/containers/storage.conf`.

Check warning on line 383 in docs/templates/extending-templates/docker-in-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.StepLength

This step's instruction has more than 20 words. Shorten it, split the step, or move the explanation to a paragraph below the instruction. Refer to procedural-writing.md#keep-steps-short.
Write the override from the agent `startup_script`, which can also start the Docker-compatible API socket:

```tf
Expand All @@ -401,7 +402,8 @@
`docker buildx` commands still require BuildKit and aren't supported.

With both settings, Podman uses native kernel overlay, which performs better than `fuse-overlayfs` and removes the device plugin dependency.
When you use native overlay, skip the smarter-device-manager steps above and remove the `github.com/fuse` limit from the pod spec; without the device plugin, that limit keeps pods in `Pending`.
When you use native overlay, skip the smarter-device-manager steps above and remove the `github.com/fuse` limit from the pod spec.
Without the device plugin, that limit keeps pods in `Pending`.

For a complete reference template, run `coder templates init --id kubernetes-podman-rootless` or refer to [`examples/templates/kubernetes-podman-rootless`](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-podman-rootless).

Expand Down
Loading