Skip to main content
Version: v2

Maintenance

This section is for people who maintain Vortex itself: the template, the CLI, the tooling package, the documentation, and the releases. Its pages explain how each part works and how to change, test, and publish it. If you're building a site from Vortex, the rest of the documentation, starting from the Introduction, is where you want to be.

The maintenance tooling lives in .vortex/, a directory the CLI leaves out of every consumer site. The ahoy commands on these pages come from .vortex/.ahoy.yml, so run them from .vortex/, or from the repository root with ahoy --file .vortex/.ahoy.yml <command>.

The following table lists the maintenance pages:

TopicDescription
TemplateMaintaining the shipped template and its testing layers
CLIHow the template CLI works and how its snapshot tests run
ToolingMaintaining the drevops/vortex-tooling scripts package
DocumentationWriting, checking, and publishing the Vortex documentation
ReleaseThe versioning strategy and the release process

The .vortex/skills/ directory holds AI agent skills for the same work. Claude Code loads them as the vortex plugin, which the repository's .claude/settings.json enables. The directory holds 4 skills:

  • prepare-vortex-release - runs the operations of the release checklist and drafts the release notes
  • create-vortex-tooling-release-notes - drafts the release notes for a drevops/vortex-tooling tag
  • propagate-vortex-main-to-2x - forward-ports commits from main to the 2.x branch
  • update-vortex-dev-deps - refreshes the Composer and Yarn development dependencies of .vortex/docs, .vortex/cli, and .vortex/tests