mirror of
https://github.com/coder/coder.git
synced 2026-10-16 14:48:56 +08:00
Nick Vigilante
25a6bf56c9
## Summary The style guide documents 77 rules. Tooling checks 8 of them, one of which doesn't run on published pages, and Vale runs advisory so no finding fails a build. Nothing said so, and several annotations said the opposite. This corrects the false claims and states the coverage where authors and agents actually read. ### The false claims Nine annotations read as active enforcement with no `(planned)` marker: - `Google.Gender`, `Google.GenderBias`, `Google.Headings`, `Google.HeadingPunctuation`, `Google.OxfordComma`, `Google.Quotes`, `Google.Exclamation`, `Google.Ranges`. The repo-root `.vale.ini` sets `BasedOnStyles = Coder`, and the doctrine in `docs/.style/README.md` deliberately excludes third-party rules. - `Coder.FirstPersonSingular` and `Coder.FirstPersonPlural`. No YAML exists for either in the rule package. All are now marked planned, matching the 17 annotations that already were. ### What changed | File | Change | |---|---| | `docs/.style/style-guide/README.md` | New "What the tooling checks, and what it doesn't" section: per-rule table with tool, severity, and scope, per-section coverage counts, and the enumeration and classification rules that reproduce them | | `docs/.style/style-guide/capitalization-and-punctuation.md`, `voice-and-tone.md`, `accessibility-and-inclusion.md` | Mark the 9 false enforcement claims planned | | `docs/.style/style-guide/audience-and-scope.md` | Give each rule its own enforcement footer, so the page's 6 rules stop counting as 1 | | `docs/.style/style-guide/word-choice.md` | Say that `Coder.BrandNames` covers `HashiCorp` casing only, and give the What's next? sub-rule its own footer | | `docs/about/contributing/documentation.md` | Drop "to enforce prose style"; state that Vale covers a subset and a clean run isn't conformance | | `AGENTS.md`, `.claude/docs/DOCS_STYLE_GUIDE.md`, `.claude/skills/write-docs/SKILL.md` | Same statement for agents; split the skill checklist item so applying the guide and passing linters are separate gates | ## Why An agent (me) wrote a new install page, ran `make lint/prose` and markdownlint clean, and shipped a draft that violated one-sentence-per-line, the "refer to" rule, `sh` fence tags, H3 tab headings, and the Learn more heading. None of those are enforced. The single checklist item that bundled "style guide applied with it open" with "Vale passes" made the substitution easy to miss. <details> <summary>Verification and method</summary> ### Empirical probe A scratch file violating 12 documented rules (gerund heading, trailing heading punctuation, first person singular and plural, `Click`, `Github`, `Hashicorp`, `VSCode`, Oxford comma, US quotation, numeric range, exclamation point, one-sentence-per-line, `Simply`, navigational `See`, `Next steps`) produced exactly 3 findings: `Coder.GerundHeading`, `Coder.SelectClick`, `Coder.BrandNames`. ### Counts One rule section is one heading with an enforcement footer (`*Enforced by ...*`, `*Documentation-only ...*`, `*Adapted from ASD-STE100 ...*`). Sections are classified against `.vale.ini` and `docs/.style/styles/Coder/` by an ordered test: a stated **Documentation-only** wins, then a check that runs today, then planned. 77 total: 8 tool-checked, 25 planned, 44 documentation-only. PR 2 in this stack adds a script that reconciles those three sources in CI so the table and the annotations can't drift from the config again. ### Two findings recorded but not fixed here - `Coder.BrandNames` ships at `error` but swaps only `Hashicorp` and `HASHICORP`, though the table it's cited under lists 8 brands. `Github` and `VSCode` pass clean. The footer now says so; widening the rule is tracked in DOCS-889. - `Coder.OneSentencePerLine` is set to `NO` repo-wide and re-enabled only for `docs/.style/*.md` and `docs/.style/styles/Coder/*.md`. Rollout tracked in DOCS-888. ### Note for the reviewer `make lint/prose` over `docs/` currently reports a backlog of `Coder.GerundHeading` warnings, plus the intentional `Coder.Demo*` findings in the annotation demo. That backlog is the advisory channel working as designed and is out of scope here, but it's the concrete evidence behind the new sentence about findings accumulating rather than blocking. Worth a separate cleanup decision: fix the headings, or re-scope the rule. </details> --- Linear: [DOCS-887](https://linear.app/codercom/issue/DOCS-887/make-clear-that-vale-passing-is-not-style-guide-conformance) PR 2 of this stack adds the CI guard that keeps these claims true. 🤖 Generated with Coder Agents on behalf of @nickvigilante.
Coder is a self-hosted platform for cloud development environments and AI coding agents. Workspaces are defined with Terraform, connected through a secure Wireguard® tunnel, and automatically shut down when not used. Coder Agents runs a native AI coding agent whose loop executes in the control plane on your infrastructure, with no API keys in workspaces.
- Define cloud development environments in Terraform
- EC2 VMs, Kubernetes Pods, Docker Containers, etc.
- Automatically shutdown idle resources to save on costs
- Onboard developers in seconds instead of days
- Delegate coding work to AI agents on your infrastructure
- Bring any model (Anthropic, OpenAI, Google, Bedrock, self-hosted)
- No LLM credentials in workspaces, user identity on every action
- Centralized model governance, cost tracking, and audit logging
Quickstart
Check out our install guides for other methods and a complete tutorial.
Try Coder with the install script on Linux and macOS, or grab the latest binary or installer from GitHub Releases on Windows:
curl -L https://coder.com/install.sh | sh
Start the server and open http://localhost:3000 to create your initial user, create a Docker template, and provision your first workspace:
coder server
For a production deployment, add a PostgreSQL database (version 13 or later) and an external access URL, and see our validated architectures for sizing and infrastructure guidance:
coder server --postgres-url <url> --access-url <url>
Without these flags, Coder uses a built-in database and sets up a *.try.coder.app access URL for evaluation. Use coder --help for the full list of flags and environment variables.
Documentation
Browse the documentation or visit a specific section below:
- Workspaces: Workspaces contain the IDEs, dependencies, and configuration information needed for software development
- Templates: Templates are written in Terraform and describe the infrastructure for workspaces
- Coder Agents: Delegate coding work to AI agents running on your self-hosted infrastructure
- AI Gateway: Centralize authentication, auditing, and cost controls for AI tooling
- Administration: Learn how to operate Coder
- Premium: Learn about paid features built for large teams
- IDEs: Connect your existing editor to a workspace
Support
Open an issue for bugs and feature requests.
For community support, showcasing what you built, and feedback on in-progress features, join our Discord or GitHub Discussions.
Dedicated support is included in Coder Premium. For more information, visit coder.com/pricing.
Integrations
New integrations are always in progress. Open an issue to request one. Contributions are welcome in any official or community repository.
Official
- Coder Registry: Templates, modules, and integrations for common development environments
- Coding Agents: Run agents like Claude Code, Codex, and OpenCode isolated in Coder workspaces
- coderd Terraform Provider: Declaratively manage your Coder deployment configuration as code
- VS Code Extension: Open any Coder workspace in VS Code with a single click
- JetBrains Toolbox Plugin: Open any Coder workspace from JetBrains Toolbox with a single click
- Dev Containers: Build development environments using
devcontainer.jsonon Docker, Kubernetes, and OpenShift - Kubernetes Log Stream: Stream Kubernetes Pod events to the Coder startup logs
- Self-Hosted VS Code Extension Marketplace: A private extension marketplace that works in restricted or airgapped networks integrating with code-server.
- GitHub Actions: An action to set up the Coder CLI in GitHub workflows
Community
- Coder Discord: Chat with the community, get support, and hear about new product updates first
- Community Templates: Community-contributed workspace templates in the Coder Registry
- Community Modules: Community-contributed modules to extend Coder templates
- Coder Template GitHub Action: A GitHub Action that updates Coder templates
- Coder Agents Chat Action: A GitHub Action that starts a Coder Agents chat against a GitHub issue or pull request
Contributing
New contributors are always welcome. If you are new to the Coder codebase, see the contribution guide to get started.
Hiring
Apply on the careers page if you are interested in joining the team.