OSS Maintainer Kit Docs Example

This repository shows what the docs-heavy preset from oss-maintainer-kit looks like after scaffolding.

It was generated with:

npx oss-maintainer-kit init . \
  --repo-name oss-maintainer-kit-docs-example \
  --maintainer "Blake Hampson" \
  --preset docs-heavy

Why this repo exists

It is a concrete example for documentation-heavy repositories where structure, examples, and clarity matter more than application code.

Quick scan

• AGENTS.md: accuracy-first review guidance
• docs/START_HERE.md: first-stop orientation for the repo owner
• docs/MAINTAINER_WORKFLOW.md: what to do when docs drift or examples break
• .github/workflows/repo-health.yml: optional docs-link and anchor checks in pull requests
• .github/workflows/codex-pr-review.yml: optional AI review automation

What this preset is trying to optimize

• fewer stale commands and broken links
• clearer navigation between canonical docs and supporting docs
• review guidance that treats docs accuracy as product quality

Related project

• Main tool: https://github.com/BlakeHampson/oss-maintainer-kit
• npm package: https://www.npmjs.com/package/oss-maintainer-kit