documentation-actions

Reusable GitHub Actions and reusable workflows for Docusaurus documentation sites and awesome-list repositories.

Extracted from duplicated automation across:

• LLazyEmail/awesome-email-marketing
• LLazyEmail/awesome-newsletters
• LLazyEmail/documentation

Modeled on LLazyEmail/email-template-workflows.

Pin LLazyEmail/documentation-actions@v1 once released. Draft adoption PRs may use @main only during the adoption window. Prefer full SHA + Renovate for production.

Table of contents

• For AI agents
• Architecture
• Quick start
• Actions and workflows
• Skills
• Adoption
• Marketplace

For AI agents

Start here:

• AGENTS.md — structured playbook with decision trees and pitfalls
• docs/quickstart-for-agents.md — ultra-concise checklist
• docs/ai-agent-guide.md — step-by-step adoption and extension flows
• docs/examples-guide.md — when to copy which example
• docs/inputs-reference.md — common inputs table
• docs/pinning.md — SHA and @v1 rules
• docs/troubleshooting.md — symptom / cause / fix
• skills/ — focused checklists (see skills/README.md)
• Copy from examples/ — never invent job YAML from scratch

Architecture

flowchart TD
  A[Consumer workflow<br/>triggers + permissions] -->|workflow_call| B[Reusable workflow<br/>.github/workflows/reusable-*.yml]
  A -->|uses step| C[Composite action<br/>actions/<name>/]
  B --> C
  D[examples/] -.->|copy-paste| A
  E[skills/] -.->|checklist| A

Loading

• Reusable workflows for whole jobs (deploy, changelog, docs-ci, auto-rebase).
• Composite actions for shared steps inside custom jobs.
• Examples are the source of truth for thin callers.
• Inventory is append-only in docs/actions-index.md.

Quick start

# Umbrella docs CI (preferred for greenfield)
jobs:
  docs-ci:
    uses: LLazyEmail/documentation-actions/.github/workflows/reusable-docs-ci.yml@v1
    with:
      working-directory: website
      cache-dependency-path: website/package-lock.json
      run-markdownlint: true
      run-lychee: true
      run-build: true
    secrets: inherit

More callers live in examples/.

Actions and workflows

See the append-only inventory: docs/actions-index.md.

Detailed reference: docs/actions/.

Skills

Reusable checklists under skills/:

• docusaurus-docs-site — full site setup and hardening.
• See skills/README.md for the full index.

Adoption

See docs/adoption.md, docs/design.md, and docs/pinning.md.

Marketplace

The root action.yml is an umbrella composite (optional markdownlint + lychee + build). Specialized actions and workflows are used by path.

License

MIT © LLazyEmail