Skip to main content
Version: v1

Maintenance

This section is for people who maintain Vortex itself: the template, the installer, the tooling package, the documentation and the releases. Its pages explain how each part works and how to change, test and publish it. To build a site from Vortex, start from the Introduction instead.

The maintenance tooling lives in .vortex/, a directory the installer 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
TemplateWriting the template's shell scripts and testing the template
InstallerHow the template installer 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. The repository's .claude/settings.json enables them as the vortex plugin, so Claude Code loads them in this repository. The directory holds 5 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-ci-runner - tests a canary build of drevops/ci-runner, then pins its released version
  • update-vortex-dev-deps - refreshes the Composer and Yarn development dependencies of .vortex/docs, .vortex/installer and .vortex/tests