| name | gravitino |
| description | Licensed to the Apache Software Foundation (ASF) under one or more Use when this capability is needed. |
| metadata | {"author":"apache"} |
name: gravitino-docs-refine
description: Use when refining Gravitino Markdown docs to match STYLE.md and pass docs audit scripts
allowed-tools: Bash
Gravitino Docs Style Refinement
Overview
Refine Markdown files under docs/ with focused, reviewable edits that follow STYLE.md.
Always validate with the audit scripts under .claude/skills/gravitino-docs-refine/scripts/ before finishing.
Refinement Workflow
- Read
STYLE.md and the target file end to end.
- Apply focused style and structure edits only.
- Run the audit scripts in the required order.
- Fix issues by file and line number.
- Re-run the full script set until all checks pass.
Audit Scripts (Required)
Run from the repository root.
| Script | What it checks | When to run |
|---|
.claude/skills/gravitino-docs-refine/scripts/title_h2_audit.py | First body H2 should not duplicate frontmatter title | After title or opening-section edits |
.claude/skills/gravitino-docs-refine/scripts/intro_audit.py | Body content should not appear before the first H2 | After restructuring page openings |
.claude/skills/gravitino-docs-refine/scripts/heading_audit.py | Heading hierarchy: first heading is H2 and no level jumps (H2 -> H4) | After heading edits |
.claude/skills/gravitino-docs-refine/scripts/heading_spacing_audit.py | One blank line before and after each H2-H6 heading | After formatting sweeps |
.claude/skills/gravitino-docs-refine/scripts/check_links.py | Internal Markdown links and anchors under docs/ | Final quality gate before PR |
Script Usage
python3 .claude/skills/gravitino-docs-refine/scripts/title_h2_audit.py
python3 .claude/skills/gravitino-docs-refine/scripts/intro_audit.py
python3 .claude/skills/gravitino-docs-refine/scripts/heading_audit.py
python3 .claude/skills/gravitino-docs-refine/scripts/heading_spacing_audit.py
python3 .claude/skills/gravitino-docs-refine/scripts/check_links.py docs/
Run as a single gate when finishing:
python3 .claude/skills/gravitino-docs-refine/scripts/title_h2_audit.py \
&& python3 .claude/skills/gravitino-docs-refine/scripts/intro_audit.py \
&& python3 .claude/skills/gravitino-docs-refine/scripts/heading_audit.py \
&& python3 .claude/skills/gravitino-docs-refine/scripts/heading_spacing_audit.py \
&& python3 .claude/skills/gravitino-docs-refine/scripts/check_links.py docs/
Completion Criteria
- Target docs comply with
STYLE.md.
- All five scripts exit with code
0.
- No unrelated files are changed.
Source: apache/gravitino — distributed by TomeVault.
