readme-platform

# ReadMe Platform Skill ReadMe.com platform integration for API documentation. ## Capabilities - Sync OpenAPI specs to ReadMe - Manage documentation versions - Configure API reference settings - Custom page management - Changelog automation - API metrics dashboard integration - Recipe/tutorial creation - Webhook and automation setup ## Usage Invoke this skill when you need to: - Deploy API documentation to ReadMe - Sync OpenAPI specifications - Manage versioned documentation - Configure API Explorer settings - Set up changelog automation ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | action | string | Yes | sync, version, page, changelog, metrics | | apiKey | string | Yes | ReadMe API key | | specPath | string | No | Path to OpenAPI spec | | version | string | No | Documentation version | | projectId | string | No | ReadMe project ID | ### Input Example ```json { "action": "sync", "apiKey": "${README_API_KEY}", "specPath": "./api/openapi.yaml", "version": "1.0" } ``` ## ReadMe CLI Configuration ### .readme.yml ```yaml # ReadMe CLI configuration version: "1.0" api: definition: ./api/openapi.yaml name: My API changelogs: directory: ./changelogs docs: directory: ./docs categories: - slug: getting-started title: Getting Started - slug: api-reference title: API Reference - slug: guides title: Guides ``` ## Sync OpenAPI Spec ### Using rdme CLI ```bash # Login to ReadMe rdme ...