Pepr Documentation

Official documentation site for Pepr - A Kubernetes controller framework built in TypeScript.

Live Site: https://docs.pepr.dev

Overview

This repository contains the build system and site structure for the Pepr documentation site. Documentation content is extracted from the Pepr core repository and built into a versioned site using Starlight.

Quick Start

Prerequisites

• Node.js (v18 or later)
• npm
• Access to the Pepr core repository

Setup

1. Clone this repository:

    git clone https://github.com/defenseunicorns/pepr-docs.git
    cd pepr-docs
    npm install

2. Clone the Pepr core repository (adjacent to pepr-docs):

cd ..
git clone https://github.com/defenseunicorns/pepr.git
cd pepr-docs

3. Create a .env file to configure the core repository path:

# Create .env file with path to Pepr core repo
# If pepr and pepr-docs are siblings:
echo 'CORE=../pepr' > .env

# If pepr is in a different location:
echo 'CORE=/path/to/pepr' > .env

Build and Run Locally

# Build the site (generates content from core repo and builds site)
npm run build

# Start development server
npm run dev

The site will be available at http://localhost:4321

Test with Netlify Environment

To test redirects or mimic the Netlify environment:

npm run build
npm run dev:netlify

Project Structure

pepr-docs/
├── scripts/                 # Build system source code
│   ├── index.mjs            # Main build orchestrator
│   ├── redirects-generator.mjs
│   └── tests/               # Test suite
├── src/                     # Site source
│   ├── content/docs/        # Documentation content (generated, gitignored)
│   ├── components/          # Astro components
│   ├── pages/               # Custom pages
│   └── styles/              # Stylesheets
├── public/                  # Static assets
├── site-docs/               # Documentation site documentation
│   ├── ARCHITECTURE.md      # Build system architecture
│   ├── CONTRIBUTING.md      # Contribution guide
│   └── REDIRECTS.md         # Redirect system guide
├── astro.config.mjs         # Astro/Starlight configuration
└── package.json

Contributing

Content changes must be made in the Pepr core repository. Site structure and UI changes should be made in this repository.

See site-docs/CONTRIBUTING.md for full guidelines.

Documentation

• ARCHITECTURE.md - Build system architecture and workflow
• CONTRIBUTING.md - Contribution guidelines and testing
• REDIRECTS.md - Redirect system documentation

Support

• Issues: GitHub Issues
• Pepr Core: GitHub
• Community: Defense Unicorns Community

License

See the main Pepr repository for license information.