docker-library/docs is a documentation repository that maintains and organizes the reference documentation for Docker Official Images.
The repository solves the problem of maintaining consistent, well-formatted documentation across a large collection of official container images. It works by storing documentation components for each image in separate folders, where source files like content.md, license.md, and maintainer.md are combined and processed through automated formatting tools to generate final README.md files. The approach separates content authoring from presentation, allowing contributors to edit source files while the build system handles formatting verification and README generation.
Contributors should know that this repository is primarily for those maintaining or documenting Docker Official Images. It suits projects that are part of the official images program and need standardized documentation. When updating existing image documentation, contributors edit content.md rather than README.md, which is auto-generated. New image documentation requires creating a folder with mandatory files including README-short.txt, content.md, license.md, maintainer.md, github-repo, and metadata.json, plus an optional logo.png. All Markdown files are validated against a specific formatting standard using markdownfmt before pull requests can merge, with common issues involving incorrect spacing between sections.
The project maintains active quality control through automated GitHub Actions that verify Markdown formatting compliance on every pull request. Documentation changes are processed through shell-based formatting and generation scripts that enforce consistency across the entire collection. The repository includes helper scripts for both template generation and repository management, indicating ongoing infrastructure maintenance alongside documentation updates.
