Skip to content

Conversation

@btiernay
Copy link
Contributor

@btiernay btiernay commented Nov 17, 2025

📝 Before you begin

By opening this PR, you agree to the terms of the Auth0 Code of Conduct. For guidance on creating a high-quality PR, see the Contributing Guidelines.

✏️ Changes

This PR adds a Claude Code skill that applies Auth0 Docs Style Guide rules when creating or correcting public Auth0 product documentation in this repository. This is intended to be used both locally and by the opt-in PR analyzer that uses Claude Code.

  • Problem solved: Ensures consistent application of Auth0 style guide rules during documentation authoring and editing
  • Docs/UI areas affected: Applies to all documentation work in main/ and auth4genai/
  • Scope: Infrastructure/tooling - adds Claude Code skill file

Source: Content taken from the Auth0 Docs Style Guide Confluence page tree, converted to markdown with extensive curation for external use.

Curation performed:

  • Removed all internal Auth0/Okta links (Google Slides, Atlassian wiki, internal Google Docs)
  • Removed internal workflow details (PM collaboration, team responsibilities, quarterly reviews)
  • Removed internal commentary and roadmap status updates
  • Cleaned up gratuitous blank lines in code blocks and lists
  • Preserved all public reference links (Google Style Guide, Microsoft Style Guide, AP Stylebook, published books)
  • Preserved all useful content, examples, and Auth0 public documentation links
  • Focused content on writing guidelines rather than internal processes

Key improvements:

  • Minimizes unnecessary loading so the skill activates only during real authoring or editing work
  • Scoped specifically for public Auth0 product documentation in the docs-v2 repository
  • Includes a consolidated quick reference table for all style guide topics
  • Adds a section calling out frequent errors and their correct forms
  • Provides a shorter, more direct workflow

The skill helps maintain consistency in:

  • Terminology and capitalization
  • Voice, tone, tense, and directive language
  • Formatting conventions, heading styles, and callout use
  • Placeholder formats and UI string handling
  • Translation-ready phrasing
  • Policy and regulatory coverage including Early Access and deprecations

When the skill loads:

  • Writing new public Auth0 product documentation
  • Editing existing docs for clarity, style, or formatting issues
  • Questions specifically about how to apply Auth0 Docs Style Guide rules

When the skill does not load:

  • Reading documentation to understand Auth0 behavior
  • Searching for information
  • General conversation about documentation
  • Implementing product code or configuration

📁 Documentation scope

Docs site(s) affected

  • main/
  • auth4genai/

Other areas

  • Shared UI library (ui/)
  • GitHub workflows (.github/workflows/)
  • Tooling or scripts (tools/)

Type of change

  • New page or major section
  • Update to existing content
  • Navigation or structure change
  • Code examples or snippets
  • UI component or Mintlify configuration
  • GitHub workflows (.github/workflows/)
  • Scripts or tooling (tools/)

Paths: .claude/skills/auth0-docs-style-guide/

🔗 References

🎯 Testing

Local validation

  • Content-only change (no build or navigation impact)
  • mint dev in affected folders
  • mint broken-links (when applicable)
  • mint a11y (when applicable)
  • npm run build in ui/ (for UI changes)

Style and structure

  • Follows the Contributing Guidelines
  • Uses correct Auth0 terminology
  • Code blocks include language and filenames when needed

Repo checks

  • All required GitHub checks are passing
  • The correct base branch is used

🔄 Redirects

Not applicable - no URL changes.

🌍 Internationalization (main docs only)

  • Not applicable - no English content changes in main/

🧩 Impact and dependencies

User-facing impact

No direct user-facing impact. This is a tooling change that affects how Claude Code applies style guide rules when authoring or editing documentation.

Dependencies

None - skill files are standalone markdown documentation for Claude Code

🚀 Deployment

  • Safe to deploy on merge

📝 Follow-up

  • No follow-up needed
  • Follow-up work required

Test plan:

  • Confirm the skill loads for tasks such as "Write a new quickstart for Auth0 authentication"
  • Confirm the skill loads for tasks such as "Fix the style issues in this doc"
  • Confirm the skill does not load for questions like "What do the docs say about connections?"
  • Ensure the quick reference table is easy to scan
  • Verify all reference file links resolve correctly

💬 Additional context

Context before:
image

Context after:
image

Listing skills:
image

@btiernay btiernay force-pushed the feat/add-auth0-docs-skill branch 2 times, most recently from 0e241cb to 11df493 Compare November 18, 2025 15:09
@btiernay btiernay marked this pull request as ready for review November 18, 2025 15:10
@btiernay btiernay marked this pull request as draft November 18, 2025 15:28
@btiernay btiernay force-pushed the feat/add-auth0-docs-skill branch 8 times, most recently from 5ab7c43 to 27a7a8f Compare November 18, 2025 17:13
Introduces a comprehensive writing-auth0-docs skill that enforces Auth0 documentation standards when authoring new content or fixing style violations. The skill provides quick reference to style guidelines covering documentation types, voice/tone, grammar, formatting, terminology, and translation readiness.

The skill includes:
- Quick reference table for common authoring tasks
- Complete Auth0 Docs Style Guide reference files
- Guidelines for documentation types, structure, and user focus
- Writing mechanics (voice, tense, grammar, punctuation)
- Formatting conventions (tables, notes, callouts, code blocks)
- Terminology and capitalization rules
- Translation-ready writing practices
- Compliance and operational policies

This skill ensures consistent, user-focused, and translation-ready documentation across the Auth0 docs-v2 repository.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@btiernay btiernay force-pushed the feat/add-auth0-docs-skill branch from 27a7a8f to c896ae4 Compare November 18, 2025 18:23
@btiernay btiernay marked this pull request as ready for review November 21, 2025 02:50
@btiernay btiernay requested a review from avanscoy November 21, 2025 22:38
@btiernay btiernay mentioned this pull request Nov 23, 2025
25 tasks
Copy link
Contributor

@KarimTantawy5 KarimTantawy5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@btiernay btiernay merged commit 53b7457 into main Nov 26, 2025
4 checks passed
@btiernay btiernay deleted the feat/add-auth0-docs-skill branch November 26, 2025 16:44
@btiernay btiernay added the gen-ai label Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants