Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.83 KB

MIGRATION.md

File metadata and controls

58 lines (40 loc) · 1.83 KB

Migration: C4-Auto to AutoDoc

AutoDoc is the new name for the automated C4 documentation CLI formerly published as @jonverrier/c4-auto.

Package and CLI

Before After
@jonverrier/c4-auto @jonverrier/auto-doc
c4-auto CLI auto-doc CLI (preferred)
— c4-auto CLI alias still available in v1.0.0

Upgrade steps

  1. Update package.json:
{
  "devDependencies": {
    "@jonverrier/auto-doc": "^1.0.0"
  },
  "scripts": {
    "generate-docs": "auto-doc --dir ./src --files \"*.ts\" \"*.tsx\" --one-month --c4component --c4context --rollup"
  }
}
  1. Replace c4-auto with auto-doc in npm scripts and CI (or keep c4-auto temporarily — it remains a compatibility alias).

  2. No change required for generated artifact filenames (README.StrongAI.Component.md, etc.) or datestamp format (<!-- Generated by StrongAIAutoDoc YYYYMMDD -->).

New in v1.0.0

Rollup design context

When using --rollup, AutoDoc includes human-authored design intent as read-only prompt context:

  • Auto-detects Design.md or DESIGN.md at the scan root or its parent directory.
  • Override with --design-file <path>.
  • Design files are never modified.
  • Rollup regenerates when the design file is newer than the existing root rollup.

Example:

auto-doc --dir ./src --files "*.ts" --one-month --c4component --rollup --design-file DESIGN.md

Release sequence

  1. @jonverrier/c4-auto@0.3.0 — design context feature (if published separately before rename).
  2. @jonverrier/auto-doc@1.0.0 — renamed package with design context and auto-doc binary.
  3. @jonverrier/agent-doc@1.0.0 — interactive MCP sibling (formerly @jonverrier/c4-diagrammer).

Related