revokslab/shipfree

Overview

This skill ensures documentation follows the project’s style and structural rules for the Next.js SaaS boilerplate. It guides content layout, titles, code formatting, and commit message conventions for consistent, readable docs.

How this skill works

It checks and enforces the documentation guidelines: short titles, concise descriptions, two-sentence text chunks, divider usage, section title style, and code snippet formatting for JS/TS. It also reminds authors to prefix commit messages with docs: when committing changes related to documentation.

When to use it

• When creating new documentation pages for the web package
• When editing existing docs to match project style and structure
• When formatting code snippets in JS or TS examples
• Before committing docs-related changes to ensure proper commit prefix
• When reviewing PRs that include documentation updates

Best practices

• Use a one- or two-word page title and a 5–10 word single-line description
• Keep paragraphs to at most two sentences and separate sections with '---'
• Write section titles in imperative mood and capitalize only the first letter
• Avoid repeating the page title inside section titles
• Strip trailing semicolons and unnecessary trailing commas in JS/TS snippets
• Prefix documentation commits with 'docs:' to signal the change type

Example use cases

• Add a new setup guide for an auth provider following the style rules
• Refactor an existing doc to split long paragraphs into two-sentence chunks
• Convert code examples to valid JS/TS formatting without trailing semicolons
• Review a PR to ensure section titles and dividers match project standards
• Prepare a compact description and title for a new feature doc