style-apply

Apply MariaDB documentation house style rules to GitBook Markdown pages.

28|115|Updated Jan 28, 2025
One-click install
npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill style-apply-mariadb-corporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: style-apply
Source: https://github.com/mariadb-corporation/mariadb-docs/tree/main/.claude/skills/style-apply
Command: npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill style-apply-mariadb-corporation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation pages drift from the MariaDB house style over time — mis-cased product names, British spellings, filler words, and inconsistent heading case accumulate and require tedious manual editorial passes before a PR can be merged. ## Core Features & Use Cases - Deterministic lint fixes: Auto-corrects mechanical violations in prose such as product name casing (MaxScale, ColumnStore, MySQL, GitHub), American spelling via codespell, filler word removal, and documented spelling agglutinations. - Judgment-item reporting: Surfaces issues that need human decision — passive voice, master/slave terminology, SQL keyword casing, timeless wording, over-linking — with file:line references and proposed rewrites. - Code-region safety: Treats fenced code blocks and {% code %} blocks as opaque, never rewriting SQL, config, or output samples. - Use Case: Before opening a documentation PR, run an editorial pass on the changed pages to auto-fix mechanical style violations and get a reviewable list of tone and structure suggestions. ## Quick Start Apply the MariaDB house style to the page server/reference/sql-statements/select.md and show me the diff plus any judgment items.

Frequently Asked Questions about style-apply

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I apply the MariaDB documentation style guide to a page?▼

Name the target page or let the skill pick up changed files from git diff. It auto-fixes mechanical violations like product name casing and filler words, then reports judgment items such as passive voice with file:line references and suggested rewrites.

What style violations does the MariaDB docs linter auto-fix?▼

Auto-fixes cover mis-cased product names (Maxscale→MaxScale, Mysql→MySQL), British spellings caught by codespell, filler words like simply and obviously, and documented spellings like commandline→command line. Ambiguous cases are flagged, not changed.

Does style checking modify code samples in Markdown?▼

No. Everything inside fenced code blocks or {% code %} blocks is treated as opaque and never edited. SQL, config, and output samples legitimately use lowercase keywords and other forms that would look like prose violations.

Can I get a style report without editing the file?▼

Yes. Request a lint-only run and the skill skips all edits, producing only the report of mechanical findings plus judgment items with file:line references and proposed rewrites for you to decide on.

When should I not use this style-checking approach?▼

Do not use it for whole-repo sweeps — that is the bulk-campaign skill's job — or for GitBook block and link syntax fixes, which belong to gitbook-format. It also does not create content or verify version claims.