YGIT Public Documentation Platform

This repository is the public documentation source for YGIT, a deployment automation platform by Vib Tools.

It is designed as a single Docusaurus codebase with four independent documentation surfaces:

User Docs  → /docs
CLI Docs   → /cli
SDK Docs   → /sdk
API Docs   → /api
Updates    → /updates

Requirements

• Node.js 20 or newer
• npm 10 or newer

Start locally

npm install
# Commit the generated package-lock.json after the first successful install.
npm run start

Validate and build

npm run validate

The production build is written to:

build/

Cloudflare Pages

Use these settings:

Production branch: main
Build command: npm run build
Build output directory: build
Node.js version: 22

The same build/ directory can be deployed to any static hosting provider.

Content rule

This repository contains public-safe content only. Do not copy internal engineering documents directly into this repository. Rewrite them for users and run:

npm run validate:public

See CONTENT_POLICY.md and CONTRIBUTING.md.