atmos docs

Use this command to open the Atmos docs or generate documentation artifacts like READMEs and release notes.

Configure Documentation Generation

Learn how to configure documentation generators for READMEs, release notes, and other artifacts.

Configuration Reference

Usage

atmos docs --help

When run on its own, the atmos docs command opens Atmos docs, but it can also display documentation for specified components. For example:

atmos docs
atmos docs vpc
atmos docs eks/cluster

Subcommands

📄️ generate

Generate documentation artifacts based on a named section under `docs.generate` in atmos.yaml