mkdocs.yml

site_name: oastools
site_description: High-performance Go library, CLI, and MCP server for working with OpenAPI Specifications (OAS 2.0, 3.0, 3.1, 3.2).
site_url: https://erraggy.github.io/oastools/
repo_url: https://github.com/erraggy/oastools
repo_name: erraggy/oastools
edit_uri: ""

theme:
  name: material
  custom_dir: overrides
  palette:
    # Light mode
    - scheme: default
      primary: teal
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: teal
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - content.code.copy

plugins:
  - search
  - exclude:
      glob:
        - plans/*

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list

nav:
  - Home: index.md
  - "🌐 Try Online": https://oastools.robnrob.com
  - Get Started:
    - Go Library: developer-guide.md
    - CLI / CI/CD: cli-reference.md
    - MCP Server: mcp-server.md
    - Claude Code Plugin: claude-code-plugin.md
  - Guides:
    - Why oastools?: why-oastools.md
    - Detecting API Breaking Changes: breaking-changes.md
    - Generator Features: generator_beyond_boilerplate.md
    - Corpus Analysis: corpus-analysis.md
    - MCP UX Findings: mcp-ux-findings.md
    - Benchmarks: benchmarks.md
  - Examples:
    - Overview: examples/index.md
    - Getting Started:
      - Quickstart: examples/quickstart.md
      - Validation Pipeline: examples/validation-pipeline.md
    - Workflows:
      - Overview: examples/workflows/index.md
      - Validate and Fix: examples/workflows/validate-and-fix.md
      - Version Conversion: examples/workflows/version-conversion.md
      - Version Migration: examples/workflows/version-migration.md
      - Multi-API Merge: examples/workflows/multi-api-merge.md
      - Collision Resolution: examples/workflows/collision-resolution.md
      - Schema Deduplication: examples/workflows/schema-deduplication.md
      - Schema Renaming: examples/workflows/schema-renaming.md
      - Fixer Showcase: examples/workflows/fixer-showcase.md
      - Pipeline Compositions: examples/workflows/pipeline-compositions.md
      - Breaking Change Detection: examples/workflows/breaking-change-detection.md
      - Overlay Transformations: examples/workflows/overlay-transformations.md
      - HTTP Validation: examples/workflows/http-validation.md
    - Programmatic API:
      - Overview: examples/programmatic-api/index.md
      - Builder: examples/programmatic-api/builder.md
    - Walker:
      - Overview: examples/walker/index.md
      - API Statistics: examples/walker/api-statistics.md
      - Security Audit: examples/walker/security-audit.md
      - Vendor Extensions: examples/walker/vendor-extensions.md
      - Public API Filter: examples/walker/public-api-filter.md
      - API Documentation: examples/walker/api-documentation.md
      - Reference Collector: examples/walker/reference-collector.md
    - Code Generation:
      - Overview: examples/petstore/index.md
      - Standard Library: examples/petstore/stdlib.md
      - Chi Router: examples/petstore/chi.md
  - Package Deep Dives:
    - Parser: packages/parser.md
    - Validator: packages/validator.md
    - Fixer: packages/fixer.md
    - Converter: packages/converter.md
    - Overlay: packages/overlay.md
    - Joiner: packages/joiner.md
    - Differ: packages/differ.md
    - HTTP Validator: packages/httpvalidator.md
    - Generator: packages/generator.md
    - Builder: packages/builder.md
    - Walker: packages/walker.md
  - Blog:
    - Building the MCP Server: blog/building-the-mcp-server.md
  - "📄 White Paper": whitepaper.md
  - Project Info:
    - Contributing: CONTRIBUTORS.md
    - License: LICENSE.md
  - API Documentation: https://pkg.go.dev/github.com/erraggy/oastools