Skip to content

docs(claude): add writing-style skill for technical prose - #849

Merged
whoisglover merged 1 commit into
mainfrom
writing-style-skill
Aug 20, 2026
Merged

docs(claude): add writing-style skill for technical prose#849
whoisglover merged 1 commit into
mainfrom
writing-style-skill

Conversation

@whoisglover

@whoisglover whoisglover commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Adds a Claude Code skill at .claude/skills/writing-style/ that sets the style for prose authored in this repo: mintlify docs pages, OpenAPI field and endpoint descriptions, changelog entries, PR descriptions, and review comments.

The rules are condensed from the Google developer documentation style guide: active voice, second person, present tense, condition before instruction, plain words, sentence-case headings, descriptive link text. A final pass strips common AI tells (buzzwords, punchy fragments, "It's not X, it's Y" constructions).

Pages under mintlify/legal/ are exempt; they remain verbatim as provided by Legal.

No effect outside Claude Code sessions.

@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Aug 20, 2026 1:01am
grid-wallet-demo Ignored Ignored Preview Aug 20, 2026 1:01am

Request Review

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@whoisglover

Copy link
Copy Markdown
Contributor Author

@greptile review

@greptile-apps

greptile-apps Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds a Claude Code skill that defines repository-wide technical writing standards and exempts verbatim legal content.

  • Covers documentation, OpenAPI descriptions, changelogs, pull requests, review comments, and commit messages.
  • Promotes direct prose, consistent formatting, and a final pass that removes common AI-writing patterns.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
.claude/skills/writing-style/SKILL.md Adds valid skill metadata and detailed prose guidance without affecting application runtime or build behavior.

Reviews (2): Last reviewed commit: "docs(claude): add writing-style skill fo..." | Re-trigger Greptile

@jklein24
jklein24 requested review from pengying and shreyav August 20, 2026 01:06
@whoisglover
whoisglover marked this pull request as ready for review August 20, 2026 02:20
@whoisglover
whoisglover merged commit d308c79 into main Aug 20, 2026
10 checks passed
@whoisglover
whoisglover deleted the writing-style-skill branch August 20, 2026 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants