A command that checks a Sumo Logic documentation file for writing style, structure, links, and frontmatter rules. Frontmatter is the metadata block at the top of a document.

Use it before submitting a pull request, after creating or editing a document, or when reviewing a contribution; run a separate SEO audit when search visibility needs checking.

It finds formatting problems, broken links, missing images, and missing or incorrectly formatted metadata before a documentation change is submitted.

How SumoLogic/sumologic-documentation configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to SumoLogic/sumologic-documentation. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/SumoLogic/sumologic-documentation/main/.claude/commands/audit-doc.md

Clone the repo

git clone --depth 1 https://github.com/SumoLogic/sumologic-documentation

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/commands/sumologic/sumologic-documentation/audit-doc/github.svg)](https://agentmods.dev/commands/sumologic/sumologic-documentation/audit-doc)

Your own site

<a href="https://agentmods.dev/commands/sumologic/sumologic-documentation/audit-doc"><img src="https://agentmods.dev/badge/commands/sumologic/sumologic-documentation/audit-doc/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/commands/sumologic/sumologic-documentation/audit-doc"><img src="https://agentmods.dev/badge/commands/sumologic/sumologic-documentation/audit-doc.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 2,647 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00000	$0.02647
Opus 5.5	$0.00000	$0.01059
Sonnet 5.5	$0.00000	$0.00529
Haiku 4.5	$0.00000	$0.00265

Measured 2mo ago against content hash 9c4ba51e8112, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

audit-doc scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/audit-doc.md · 375 lines

How it starts

The opening of the file, as written. The whole thing — 375 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Audit Doc — Documentation Quality Check

Use this command to audit a doc for Sumo Logic style, structure, links, and frontmatter compliance — run it before submitting any PR, after creating a new doc, or when reviewing community contributions.

Gotchas

H1 headings and the title frontmatter field use Title Case. H2, H3, H4 use sentence case (only first word and proper nouns capitalized).
Skip warnings for legacy docs with an established style, docs tagged noindex (temporary drafts), or third-party content not meant to be modified.
/audit-doc does not check SEO/AEO/GEO signals — run /seo-audit separately for discoverability.

When to use this command

Before submitting a PR to check doc quality
After creating a new doc to validate structure
When updating existing docs to ensure consistency
To identify broken links or missing images
When reviewing community contributions

Workflow

Step 1: Identify the doc to audit

Ask the user for:

File path: Full path to the markdown file to audit
Doc type (optional): App, feature, how-to, concept, reference, release note
Strictness level (optional): Lenient, standard, or strict

If no file path provided, ask user to specify the file.

Step 2: Read the file

Use the Read tool to read the complete file content.

Step 3: Analyze frontmatter

Check for required fields and proper formatting:

Universal requirements:

id field present and matches filename (without .md)
title field present, Title Case, under 60 characters
No frontmatter syntax errors (proper YAML format)

For docs (not release notes):

description field present, 140–160 characters (Warning if under 100 or over 160; Suggestion if 100–139)
Description starts with "The Sumo Logic..."
sidebar_label (if present) is shorter than title

For app docs:

image field with valid S3 URL or local path
tags includes "apps" and vendor slug

For release notes:

hide_table_of_contents: true present
image uses standard Sumo Logic preview URL
keywords present (unless Collector type)

Read the full file on GitHub · 375 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 375 lines · 0 tokens per session scan A 9c4ba51e8112

Subscribe to this mod's changes

audit-doc is a command published in the GitHub repository SumoLogic/sumologic-documentation (42 stars, last pushed yesterday), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 2,647 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Legal and compliance React documentation open-source

audit-doc next to 6 commands from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
audit-docSumoLogic/sumologic-documentation	Command	42	yesterday	MIT	A	0	Claude Code
checklistgithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
clarifygithub/spec-kit	Command	148k	yesterday	MIT	A	27	Claude Code
specifygithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
analyzegithub/spec-kit	Command	148k	yesterday	MIT	A	26	Claude Code
convergegithub/spec-kit	Command	148k	yesterday	MIT	A	35	Claude Code
implementgithub/spec-kit	Command	148k	yesterday	MIT	A	14	Claude Code

sumologic-documentation: Command for Claude Code