Contribution Guide

[avanscoy]

📝 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

Adding the Contribution Guide. This Guide is going to be part of the PR Template in draft by @btiernay.

• Problem solved: Provides requirements and references on how to contribute to help get the repo ready for contributions from Auth0 Staff
• Docs/UI areas affected: main/ documentation site
• Scope: Adds comprehensive contribution guidelines including references to Mintlify and Auth0 Product Documentation best practices to ensure clarity and coherence

📁 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: main/CONTRIBUTION.mdx

🔗 References

• Mintlify documentation
• Auth0 Product Documentation best practices (internal)
• Screenshot Use Policy (internal)
• Auth0 Docs Style Guide (internal)

Related PRs:

• PR #301 - GitHub pull request template
• PR #333 - Add taking-screenshots skill for standardized documentation screenshots
• PR #299 - Add Auth0 Docs Style Guide skill for Claude Code

🎯 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 being used

🔄 Redirects

Not applicable - no URL changes.

🌍 Internationalization (main docs only)

• Not applicable - contribution guide is not part of localized content

🧩 Impact and dependencies

User-facing impact

• Establishes clear contribution guidelines for Auth0 Staff contributors
• Provides references to Mintlify documentation and best practices
• Documents file standards, heading requirements, formatting guidelines
• Includes screenshot policy guidance

Dependencies

• Complements the PR template being developed by @btiernay
• References internal Auth0 documentation (Style Guide, Screenshot Policy)

🚀 Deployment

• Safe to deploy on merge

📝 Follow-up

• No follow-up needed

💬 Additional context

This contribution guide includes comprehensive documentation for Auth0 Staff contributors covering:

• General guidelines: Links to internal style guide and documentation resources
• Docs-as-code workflow: GitHub account requirements, Mintlify references, local environment setup
• File standards: Naming conventions (hyphenated, not camelCase or underscores)
• File headings: Complete reference for metadata fields including og:description, og:title, permalink, sidebarTitle, etc.
• Format text: Markdown formatting with accessibility considerations (no italics, minimal underline)
• Media: Image upload requirements, screenshot guidelines, and policy references
• Embedded content types: Guidance on warnings, notes, lists, and other UI elements

The guide ensures consistency and quality across all documentation contributions.

Tip

Useful references:

• Contributing Guidelines
• Mintlify documentation: https://www.mintlify.com/docs
• main README
• auth4genai README

[btiernay]

Line 82: Incomplete sentence

2. Scroll down the 

This sentence is cut off mid-thought. Please complete it or remove the incomplete example.