PlexAPI.dev Mintlify Documentation

This repository powers the PlexAPI.dev documentation site, hosted on Mintlify.

What's inside

• docs.json – Mintlify site configuration and navigation.
• *.mdx – Documentation pages for the Getting Started section.
• openapi-with-code-samples.yaml – OpenAPI specification used to generate the API Reference.
• .speakeasy/ – Speakeasy workflow that merges code samples into the OpenAPI spec.

Local development

Install the Mintlify CLI:

npm i -g mintlify

Run the local preview server from the repository root:

mintlify dev

Updating the API reference spec

The API reference is generated from openapi-with-code-samples.yaml. To refresh it with the latest Speakeasy code samples, run:

speakeasy run workflow --source merge-code-samples-into-spec

The canonical OpenAPI specification lives in the PlexAPI.dev monorepo. Updates to the canonical spec are made there; this repository consumes a rendered, sample-rich version for documentation.

Publishing

This site is deployed through the Mintlify GitHub App. Changes pushed to the default branch are published automatically.

Contributing

See the Contributing page for content style rules, validation commands, and the review process.