Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.allthingslinux.org/llms.txt

Use this file to discover all available pages before exploring further.

The specification bundled here is Mintlify’s Plant Store demo. It exists so you can exercise the interactive API playground and MDX openapi frontmatter. It does not represent a production All Things Linux API unless we publish a separate product spec.

Two ways to document APIs

Mintlify supports:
  • OpenAPI-driven pages — Endpoints are generated from api-reference/openapi.json, which is registered in docs.json under api.openapi. The playground uses this spec for try-it-out requests.
  • MDX with openapi frontmatter — Manual pages (like the endpoint examples in this tab) bind to operations in the same spec.
See the OpenAPI setup guide for advanced layout and navigation options.

This repo’s spec

The OpenAPI file lives at api-reference/openapi.json in the monorepo. docs.json enables the playground and allows downloading the spec from API pages.

Authentication (example)

The sample spec declares Bearer auth:
"security": [
  {
    "bearerAuth": []
  }
]
Use the playground’s auth controls when testing—values are for the sandbox server declared in the spec, not ATL production services.

Production APIs

When a stable public API is ready, replace or supplement this spec, update servers and security schemes, and adjust navigation so generated pages match your product. Until then, treat all paths under the sample as illustrative only.