-
Notifications
You must be signed in to change notification settings - Fork 14.9k
[Style Guide] Add rules against LLM-written content patterns #31269
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.
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
Draft
mvvmm
wants to merge
3
commits into
production
Choose a base branch
from
style-guide/emoji-admonitions
base: production
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+15
−2
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -72,11 +72,21 @@ reviewed: 2025-01-15 | |||||
| - **Imperative mood for procedures.** Start steps with a verb: "Select", "Run", "Go to". | ||||||
| - **Plain language.** Avoid obscure words and jargon. Define acronyms on first use. | ||||||
| - **Objective first, then action.** "To create a tunnel, run..." not "Run this command to create a tunnel." | ||||||
| - **Avoid LLM-filler phrases.** Do not use "It's important to note", "leverage", "seamless", "dive into", "straightforward", or similar. | ||||||
| - **Avoid LLM-filler phrases and marketing language.** Do not use: "It's important to note", "leverage", "seamless", "dive into", "straightforward", "robust", "powerful", "cutting-edge", "unlock", "out of the box", "at a glance", or similar. Write what the thing actually does. | ||||||
| - Replace `e.g.` with "for example" and `i.e.` with "that is". Never use `etc.` — rewrite or list items explicitly. | ||||||
| - Do not use "please" in instructions. | ||||||
| - Do not use directional language ("above", "below", "on the right") — reference elements by name instead. | ||||||
| - No emojis in page titles, headings, or sidebar labels. | ||||||
| - **No emojis anywhere in docs.** No emoji in prose, titles, headings, sidebar labels, or tables. Do not use emoji as admonition substitutes — `💡 Tip:` and `⚠️ Warning:` in prose are not supported patterns. Use `:::tip` and `:::caution` instead. | ||||||
| - **Avoid LLM-written patterns.** These are the most common tells — flag and fix them: | ||||||
| - **Em dashes overused.** One per page is a sign of good writing. One per paragraph is not. Restructure or use a comma or period. | ||||||
| - **Journalistic/magazine voice.** Docs are not blog posts. Cut scene-setting, dramatic framing, and rhetorical questions. Get to the information. | ||||||
| - **Filler qualifiers.** "Simply", "just", "easily", "quickly" — remove them. They add no information and imply the reader is at fault if they struggle. | ||||||
| - **Throat-clearing intros.** "In this guide, you will learn..." and "By the end of this tutorial..." restate the title. Delete them. | ||||||
| - **Closing summaries.** Paragraphs that restate what was just written. Delete them. | ||||||
| - **"We" and "let's".** Use imperative ("Run the command") or second person ("You can configure..."). Not "Let's run" or "We will configure". | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix grammar to match imperative style of surrounding bullets:
Suggested change
|
||||||
| - **✅/❌/⚠️ in tables.** Use plain text: "Yes", "No", "Partial". | ||||||
| - **Manual tables of contents.** A bulleted list of anchor links at the top of a page is always wrong. The sidebar and on-page TOC handle navigation. | ||||||
| - **Arbitrary bold.** Bold is for key terms and UI element names. If a sentence needs bold to make its point, rewrite the sentence. | ||||||
|
|
||||||
| ### Abbreviations and acronyms | ||||||
|
|
||||||
|
|
@@ -364,6 +374,7 @@ Usage rules: | |||||
| - No more than one admonition of the same type per section. | ||||||
| - Do not add a header to admonitions inside numbered step instructions — the background color is sufficient. | ||||||
| - Use admonitions sparingly overall. If most of a page is wrapped in them, restructure the content. | ||||||
| - **Do not use emoji as inline admonition substitutes.** Patterns like `💡 Tip:`, `⚠️ Warning:`, or `ℹ️ Note:` in prose are not supported. Always use the `:::note`, `:::caution`, or `:::tip` directive syntax. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
|
|
||||||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use imperative mood to match the surrounding bullets: