Repository navigation
feat: enable Coder.Please Vale rule - #30789
Merged
nickvigilante merged 2 commits intoOct 24, 2026
Merged
Conversation
Contributor
nickvigilante
force-pushed
the
vigilante/docs-1281-add-coderplease-vale-rule
branch
from
October 14, 2026 20:55
a30a9a4 to
6cefe5d
Compare
Base automatically changed from
vigilante/docs-1282-style-guide-add-missing-rules-from-the-docs-style-guide
to
main
October 16, 2026 13:53
nickvigilante
marked this pull request as ready for review
October 23, 2026 05:44
Rewrites 31 prose uses of "please" as direct imperatives, plus the telemetry group description in codersdk and the golden files and configuration reference generated from it.
Flags "please" at warning severity and flips the style guide footer from planned to enforced.
nickvigilante
force-pushed
the
vigilante/docs-1281-add-coderplease-vale-rule
branch
from
October 24, 2026 02:56
ec79154 to
3c3724e
Compare
Collaborator
Author
|
The Generated by Coder Agents on behalf of @nickvigilante. |
nickvigilante
deleted the
vigilante/docs-1281-add-coderplease-vale-rule
branch
October 24, 2026 04:18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on #30782.
Adds
Coder.Please, a Vale rule that enforces Leave out "please".\bplease\b, ignoring case.warning. Scope:docs/**exceptdocs/.style/style-guide/**.Please try again laterstays untouched, as the guide asks.Commits
docs: leave "please" out of instructions: rewrites each use as a direct imperative and keeps the meaning.It also fixes the one generated page that had a finding.
docs/admin/setup/configuration-reference.mdcomes from the telemetry group description incodersdk/deployment.go, so the cleanup edits that source and the golden files (cli/testdata/coder_server_--help.golden,cli/testdata/server-config.yaml.golden,enterprise/cli/testdata/coder_server_--help.golden) regenerated withgo test -update.feat(docs/.style): enable Coder.Please Vale rule: adds the rule, flips the footer to enforced, adds the checks-table row, and updates the coverage counts.No
.vale.inichange is needed, and no generated page is excluded.Linear: DOCS-1281
Decision log
existencerule with one\bplease\btoken. Word boundaries keeppleasantanddispleasingout.warningrather thanerror, because a quoted product message can legitimately contain the word outside code font.body=please+enter+your+request+herearen't flagged, because Vale skips link destinations.Test cases (fixtures under
/tmp/please-test/, not committed), run with LF and CRLF line endings, 6 findings each:Please, trailing, please.,PLEASE, a blockquote, a list item, a heading.Please try again later, a fenced code block containingPlease install curl,pleasant,displeasing.Checks:
vale --output=line docs/reports 0Coder.Pleasefindings.go run ./scripts/styleclaimspasses.lint/go,lint/ts, markdown, emdash, style-claims, typos).go test ./cli -run 'Test(CommandHelp|ServerYAML)'andgo test ./enterprise/cli -run TestEnterpriseCommandHelppass with the updated golden files.Generated by Coder Agents on behalf of @nickvigilante.