Skip to content

[Style Guide] Add rules against LLM-written content patterns#31269

Draft
mvvmm wants to merge 3 commits into
productionfrom
style-guide/emoji-admonitions
Draft

[Style Guide] Add rules against LLM-written content patterns#31269
mvvmm wants to merge 3 commits into
productionfrom
style-guide/emoji-admonitions

Conversation

@mvvmm
Copy link
Copy Markdown
Contributor

@mvvmm mvvmm commented Jun 5, 2026

Summary

Adds explicit rules to the agent style guide reference and the human-facing admonitions page covering patterns that appear frequently in LLM-generated docs:

  • Emoji used as inline admonition substitutes (💡 Tip:, ⚠️ Warning:) instead of :::note/:::caution/:::tip directives
  • A catch-all "avoid obviously LLM-written patterns" rule with concrete examples (em dashes, "simply"/"just", throat-clearing intros, ✅/❌ table columns, manual TOCs, etc.)

Documentation checklist

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
* @cloudflare/product-owners
/src/content/docs/style-guide/ @dcpena, @caley-b, @cloudflare/product-owners

@mvvmm mvvmm force-pushed the style-guide/emoji-admonitions branch from 703ea3a to 54ffadc Compare June 5, 2026 23:15
@ask-bonk ask-bonk Bot added documentation Documentation edits content:edit Request for content edits labels Jun 5, 2026
Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue needs fixing before merge.

CRITICAL — and contain unrelated dependency bumps (astro, vitest, wrangler, typescript-eslint, etc.) that are not mentioned in the PR title or description. Remove these files from the PR to avoid scope creep and unintended side effects.

LOW — Posted 1 inline suggestion for grammar consistency in the agent reference.

Out of scope — The PR description lists many LLM anti-patterns, but the human-facing style guide only reflects the emoji-as-admonition rule. Consider whether rules like "no throat-clearing introductions" and "avoid condescending qualifiers" should also appear in the human-facing writing guidelines.

- **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".
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammar to match imperative style of surrounding bullets:

Suggested change
- **"We" and "let's".** Use imperative ("Run the command") or second person ("You can configure..."). Not "Let's run" or "We will configure".
- **Use em dashes sparingly.** An occasional em dash for a sharp aside is fine; using them in every other sentence is a sign the sentence should be restructured. Prefer a period or a comma.

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented Jun 5, 2026

Correction to my review above: The filenames got mangled by shell escaping. The files that need to be removed from this PR are package.json and pnpm-lock.yaml.

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented Jun 5, 2026

I've completed the review for PR #31269.

Labels applied: documentation, content:edit

Summary of changes

  • Adds 12 new anti-LLM writing rules to .agents/references/style-guide.md (LLM-filler phrases, condescending qualifiers, throat-clearing introductions, summary paragraphs, "we"/"let's", "note that", "ensure", "as mentioned above", em dashes, emojis in prose/tables, manual TOCs, and bold misuse).
  • Adds a matching emoji-as-admonition rule to the human-facing page src/content/docs/style-guide/formatting/notes-and-other-notation-types.mdx.
  • Accidentally includes dependency bumps in package.json and pnpm-lock.yaml (astro, vitest, wrangler, typescript-eslint, etc.) totaling ~900 lines of diff.

Issues flagged

  • CRITICALpackage.json and pnpm-lock.yaml contain unrelated dependency bumps not mentioned in the PR title or description. These should be removed from the PR to avoid scope creep and unintended side effects.
  • LOW — Posted 1 inline suggestion on .agents/references/style-guide.md line 86: "Em dashes sparingly" should be "Use em dashes sparingly" to match the imperative style of the surrounding bullets.
  • Out of scope note — The PR description lists many LLM anti-patterns, but the human-facing style guide only reflects the emoji-as-admonition rule. Consider whether rules like "no throat-clearing introductions" and "avoid condescending qualifiers" should also appear in the human-facing writing guidelines (e.g. writing-guidelines.mdx).

github run

@mvvmm
Copy link
Copy Markdown
Contributor Author

mvvmm commented Jun 6, 2026

/bonk re-review

Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue needs fixing before merge.

LOW.agents/references/style-guide.md line 81: The em dashes bullet does not use imperative mood, which is inconsistent with the other top-level writing style bullets.

Posted 1 inline suggestion.

- 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.
Copy link
Copy Markdown
Contributor

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:

Suggested change
- **Em dashes overused.** One per page is a sign of good writing. One per paragraph is not. Restructure or use a comma or period.
- **Use em dashes sparingly.** One per page is a sign of good writing. One per paragraph is not. Restructure or use a comma or period.

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented Jun 6, 2026

Posted the re-review on PR #31269.

What I found:

  • The package.json and pnpm-lock.yaml files were successfully removed — that critical issue is resolved.
  • One grammar issue remains from the previous review: .agents/references/style-guide.md line 81 ("Em dashes overused.") still doesn't match the imperative mood used by the surrounding top-level bullets. I posted an inline suggestion to change it to "Use em dashes sparingly."
  • The new rules against LLM-written patterns and emoji admonitions are otherwise clear and well-placed.

github run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:edit Request for content edits documentation Documentation edits product:style-guide size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant