Skip to main content

​
AGENTS.md

This file provides guidance to agents when working with code in this repository.

​
Overview

This is a Mintlify documentation project for the OASM (Open Attack Surface Management) platform. It is NOT the main application codebase—it’s the documentation site that references other repositories.

​
Development Commands

npm i -g mint          # Install Mintlify CLI globally
mint dev              # Start local documentation server at http://localhost:3000
mint update           # Update Mintlify CLI to latest version

​
Project Structure

  • .mdx files → Documentation pages (use frontmatter with title and optional description)
  • docs.json → Navigation configuration (tabs, groups, colors, icons)
  • api-reference/openapi.json → OpenAPI specification for API docs
  • snippets/ → Reusable MDX snippets

​
Non-Obvious Patterns

  • Navigation: Configured in docs.json under navigation.tabs with nested groups—changes here affect the sidebar structure
  • Icons: Groups and tabs can have icons using Lucide icon names (e.g., "icon": "rocket", "icon": "book-open")
  • Icons: Uses Lucide icons library (configured in docs.json under icons.library)
  • AI Integrations: The contextual.options in docs.json enables AI chat features (chatgpt, claude, perplexity, mcp, cursor, vscode)
  • Multi-repo: This docs site references two external repositories:
    • github.com/oasm-platform/open-asm (main backend)
    • github.com/oasm-platform/oasm-docker (Docker deployment)

​
Code Style (MDX)

  • Use --- frontmatter delimiters with YAML between
  • Standard Mintlify components: <Card>, <Steps>, <Step>, <Info>, <Accordion>, <CodeGroup>
  • Links use relative paths (e.g., href="/quickstart")