Skip to content

DOCS-1640 - Consolidate Claude commands and add bulk change guidance#6716

Draft
kimsauce wants to merge 11 commits into
mainfrom
DOCS-1640
Draft

DOCS-1640 - Consolidate Claude commands and add bulk change guidance#6716
kimsauce wants to merge 11 commits into
mainfrom
DOCS-1640

Conversation

@kimsauce

@kimsauce kimsauce commented May 20, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

Cleans up the Claude Code setup in this repo — removes redundant commands, deduplicates overlapping checks between /audit-doc and /seo-audit, fixes a heading case bug, and adds durable institutional guardrails for bulk doc changes.

Deleted 3 redundant style commands

Deleted /tone-check, /simplify, and /rewrite-intro — the rules they contained are already covered by the sumo-style skill and applied automatically on every doc edit. Standalone slash commands were unlikely to be invoked directly.

Removed corresponding rows from the CLAUDE.md command table.

Bug fix in audit-doc.md

Corrected heading case rule from "Title Case" to "sentence case" to match actual repo convention (titles use Title Case; H2+ headings use sentence case).

Dead weight stripped from audit-doc.md and doc.md

Removed low-value sections from both files: scripted example dialogues, post-completion messages, tips and best practices, error handling for edge cases, and references — none of these affect runtime behavior.

## What this command does and ## When to use this command are kept — these provide context for when to proactively suggest each command.

Deduplicated seo-audit.md

Removed checks already covered by /audit-doc:

  • title present
  • description present
  • No H1 in body
  • No skipped heading levels
  • Image alt text presence (quality check kept)
  • Bare URLs / descriptive link text

/seo-audit now focuses exclusively on SEO/AEO/GEO signals that /audit-doc does not cover.

Also removed two stale references to the deleted /tone-check command.

New Bulk Changes section — CLAUDE.md

Adds a short Bulk Changes section capturing institutional guardrails from the DOCS-63 post-mortem: don't revert from memory, atomic commits per directory, no committed helper scripts, dry-run before writing.

Chosen over a /bulk-doc-change skill (originally proposed in DOCS-1526) because newer Claude models handle the workflow naturally — the unique value is the guardrails, not a five-step wrapper.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1640
https://sumologic.atlassian.net/browse/DOCS-1526

…ase notes

- Consolidate 5 release-note-* commands into a single release-note.md
- Remove "What this command does", "When to use", "Post-completion message",
  "Tips", "After the X", "Example usage", and generic error-handling sections
  from audit-doc, doc, doc-from-jira, geo-optimize, remove-doc, rewrite-intro,
  seo-audit, simplify, and tone-check commands
- Update CLAUDE.md slash command table to reference /release-note

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label May 20, 2026
@kimsauce kimsauce self-assigned this May 20, 2026
kimsauce and others added 2 commits May 20, 2026 02:29
Applies audit-doc checks to all changed .md files in a PR and produces
a consolidated review comment. Read-only — surfaces issues without fixing.
Also fixes sentence case rule in audit-doc.md (was incorrectly Title Case).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Rules are covered by the sumo-style skill. Standalone commands were
unlikely to be invoked and added clutter to the command list.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kimsauce kimsauce changed the title DOCS-1640 - Trim dead weight from Claude commands and consolidate release notes DOCS-1640 - Audit and consolidate Claude commands and skills May 20, 2026
@kimsauce kimsauce marked this pull request as ready for review June 5, 2026 05:05
kimsauce and others added 5 commits June 5, 2026 00:26
* DOCS-1634 - Fix MCP server and OAuth docs (#6710)

* DOCS-1634 - Fix MCP server and OAuth docs

- Remove VS Code and ChatGPT sections from MCP server doc; scope prereqs to any OAuth 2.0 Authorization Code-compatible client
- Fix claude mcp add command syntax for --client-secret flag
- Expand OAuth client setup steps inline for Claude Code CLI
- Soften prerequisite language in both docs
- Rewrite Auth Code flow Step 2 to be actionable
- Replace hardcoded deployment URLs with <token-endpoint-URL> and <api-endpoint> placeholders in Client Credentials Step 3
- Add deployment token endpoint table to FAQ
- Fix /oauth/token typo to /oauth2/token throughout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DOCS-1634: Add Known limitations section to MCP server doc

Documents that Cursor (cursor:// redirect URLs unsupported) and recent
VS Code releases (auth code flow broken with explicit client credentials)
are not currently supported. Includes a note to contact support.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* Bump webpack-dev-server from 5.2.2 to 5.2.4 (#6718)

Bumps [webpack-dev-server](https://github.com/webpack/webpack-dev-server) from 5.2.2 to 5.2.4.
- [Release notes](https://github.com/webpack/webpack-dev-server/releases)
- [Changelog](https://github.com/webpack/webpack-dev-server/blob/main/CHANGELOG.md)
- [Commits](webpack/webpack-dev-server@v5.2.2...v5.2.4)

---
updated-dependencies:
- dependency-name: webpack-dev-server
  dependency-version: 5.2.4
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* DOCS-1526 - Add Bulk Changes guardrails to CLAUDE.md

Distill the DOCS-63 post-mortem lessons into a short CLAUDE.md section
instead of a full bulk-doc-change skill. Newer models handle most of
the workflow naturally; only the non-obvious institutional rules
(no revert from memory, atomic commits per directory, no committed
helper scripts) need to persist as durable guidance.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@kimsauce kimsauce marked this pull request as draft June 5, 2026 08:09
@kimsauce kimsauce changed the title DOCS-1640 - Audit and consolidate Claude commands and skills DOCS-1640 - Consolidate Claude commands and add bulk change guidance Jun 5, 2026
kimsauce and others added 3 commits June 8, 2026 07:20
- audit-doc, doc, seo-audit: replace generic "What this command does" steps with imperative descriptions and a Gotchas section
- audit-doc: fix heading case rule (H1 Title Case, H2–H4 sentence case); restore redundant when-to-use bullet
- seo-audit: restore dropped checks (anchor text, bare URLs, missing alt, Critical table rows)
- CLAUDE.md: add plan mode requirement for bulk changes; clarify bulk change examples with e.g.; remove opaque DOCS-63 reference

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Added guidelines for branch naming and commit approval process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant