Snider 97aab0fcca docs: add VitePress documentation with GitHub Pages deployment

- VitePress config with canonical URLs to core.help
- Developer preview banner linking to main docs
- Documentation pages: quick-start, commands, core-folder, repos-yaml
- GitHub Actions workflow for Pages deployment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-31 20:28:07 +00:00

1.1 KiB

Raw Blame History

Quick Start

Get a complete Host UK development environment in under 5 minutes.

Prerequisites

Git
GitHub CLI (gh)
SSH key configured with GitHub

Installation

macOS / Linux

git clone git@github.com:host-uk/core-devops.git
cd core-devops
make setup

Windows (PowerShell as Admin)

git clone git@github.com:host-uk/core-devops.git
cd core-devops
.\scripts\install-deps.ps1
.\scripts\install-core.ps1
core setup

What Happens

make setup does three things:

Installs dependencies - PHP 8.3+, Composer, Node 20+, pnpm, GitHub CLI
Installs the core CLI - Multi-repo management tool
Clones all packages - Into packages/ (foundation and modules by default)

Verify Installation

core doctor

This checks that all required tools are installed and configured.

Next Steps

# See workspace status
core health

# Run tests in the active package
core php test

# Work on a specific package
cd packages/core-php
composer test

Troubleshooting

See the Troubleshooting Guide for common issues.

1.1 KiB Raw Blame History