Run any Skill in Manus with one click

lint-docs

Stars64

Forks13

UpdatedApril 23, 2026 at 15:35

Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

MuhammadUsmanGM

MuhammadUsmanGM/claude-code-best-practices

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	lint-docs
description	Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.
allowed-tools	Bash(shellcheck:), Bash(markdownlint:), Bash(bash tools/lint-claude-md.sh:), Bash(find:), Bash(git status:*), Read

Lint Docs

Run the same three checks CI runs and report pass/fail per check.

Steps

shellcheck — find every .sh under the repo and run shellcheck on it.

find . -name '*.sh' -not -path './.git/*' -print0 | xargs -0 shellcheck

markdownlint — run markdownlint on README.md, CONTRIBUTING.md, CHANGELOG.md, and everything under guides/, examples/, plugins/, tools/hooks/. Use .markdownlint.json at repo root.
lint-claude-md — run bash tools/lint-claude-md.sh against every examples/claude-md-*.md template and the repo's own CLAUDE.md.

Output

Print a single summary table, one row per check:

Check	Status	Details

If any check fails, print the first 20 lines of its output below the table and stop. Do not try to auto-fix unless the user asks.

Rules

If shellcheck or markdownlint isn't installed, say so and skip that check — don't silently pass.
Do not modify files. This skill is diagnostic only.

More from this repository

same repository

add-handler

MuhammadUsmanGM/claude-code-best-practices

Scaffold a new HTTP handler with service function, store method (if needed), and table-driven test, following the project's internal/{api,service,store} layout. Invoke when the user asks to add an endpoint, handler, or route.

2026-04-2364

api-endpoint

MuhammadUsmanGM/claude-code-best-practices

Scaffold a new API endpoint with request/response Pydantic schemas, service function, route handler, and a pytest test — following the project's layered layout. Invoke when the user asks to add an endpoint, route, or API method.

2026-04-2364

component-new

MuhammadUsmanGM/claude-code-best-practices

Scaffold a new React component with matching test file and consistent folder layout, following the project's conventions in src/features or src/components. Invoke when the user asks to create, scaffold, or add a new component.

2026-04-2364

test-component

MuhammadUsmanGM/claude-code-best-practices

Write React Testing Library tests for an existing component, following the project's RTL conventions (prefer role/label queries, mock at network boundary, no act()). Invoke when the user asks to test, add tests for, or cover a component.

2026-04-2364

changelog

MuhammadUsmanGM/claude-code-best-practices

Generate or update CHANGELOG.md with an entry for the unreleased changes since the last git tag. Invoke when the user asks to cut a release, update the changelog, or summarize changes since v-something.

2026-04-2364

pr-describe

MuhammadUsmanGM/claude-code-best-practices

Write a pull-request title and body from the current branch's commits and diff against the base branch. Invoke when the user asks to open a PR, draft a PR description, or summarize a branch.

2026-04-2364

name	lint-docs
description	Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.
allowed-tools	Bash(shellcheck:), Bash(markdownlint:), Bash(bash tools/lint-claude-md.sh:), Bash(find:), Bash(git status:*), Read

Lint Docs

Run the same three checks CI runs and report pass/fail per check.

Steps

shellcheck — find every .sh under the repo and run shellcheck on it.

find . -name '*.sh' -not -path './.git/*' -print0 | xargs -0 shellcheck

markdownlint — run markdownlint on README.md, CONTRIBUTING.md, CHANGELOG.md, and everything under guides/, examples/, plugins/, tools/hooks/. Use .markdownlint.json at repo root.
lint-claude-md — run bash tools/lint-claude-md.sh against every examples/claude-md-*.md template and the repo's own CLAUDE.md.

Output

Print a single summary table, one row per check:

Check	Status	Details

If any check fails, print the first 20 lines of its output below the table and stop. Do not try to auto-fix unless the user asks.

Rules

If shellcheck or markdownlint isn't installed, say so and skip that check — don't silently pass.
Do not modify files. This skill is diagnostic only.