Documentation

A modern, fast, and feature-rich documentation website built with Hugo and the Hextra theme.

Features

• 📝 Fast & Lightweight: Built with Hugo, one of the fastest static site generators
• 🎨 Modern Design: Clean and responsive UI powered by the Hextra theme
• 🔍 Full-Text Search: Built-in search functionality
• 🌙 Dark Mode: Automatic dark mode support
• 📱 Mobile-Friendly: Fully responsive design
• 🚀 SEO Optimized: Built-in SEO best practices
• 📦 Easy to Deploy: Static files that can be hosted anywhere

Prerequisites

• Hugo (Extended version >= 0.112.0)
• Git

Getting Started

Installation

1. Clone the repository:

git clone https://github.com/uug-ai/documentation.git
cd documentation

2. Install the Hextra theme:

cd app
hugo mod get -u github.com/imfing/hextra

To work on the theme locally, vendor it into the project:

cd app
hugo mod vendor

This makes the Hextra source available under app/_vendor/github.com/imfing/hextra/, including editable CSS files such as assets/css/styles.css and assets/css/custom.css.

Or if using Git submodules:

git submodule add https://github.com/imfing/hextra.git app/themes/hextra
git submodule update --init --recursive

Local Development

1. Navigate to the app directory:

cd app

2. Start the Hugo development server:

hugo server -D

3. Open your browser and visit http://localhost:1313

The site will automatically reload when you make changes to the content.

Project Structure

.
├── app/
│   ├── archetypes/       # Content templates
│   ├── assets/           # CSS, JS, images
│   ├── content/          # Documentation content (Markdown files)
│   ├── data/             # Data files
│   ├── i18n/             # Internationalization files
│   ├── layouts/          # Custom layout templates
│   ├── static/           # Static files (copied as-is)
│   ├── themes/           # Hugo themes
│   └── hugo.toml         # Hugo configuration
├── Dockerfile            # Docker configuration
└── README.md            # This file

Creating Content

Adding a New Page

Create a new Markdown file in the app/content/ directory:

cd app
hugo new docs/your-page.md

Edit the file with your content:

---
title: "Your Page Title"
date: 2025-11-07
draft: false
---

Your content here...

Organizing Content

Content is organized in the app/content/ directory. Create subdirectories to structure your documentation:

content/
├── _index.md          # Homepage
├── docs/
│   ├── _index.md      # Docs section index
│   ├── getting-started/
│   ├── guides/
│   └── reference/

Configuration

The main configuration file is app/hugo.toml. Customize it to match your project:

baseURL = 'https://docs.example.com/'
languageCode = 'en-us'
title = 'Your Documentation Site'
theme = 'hextra'

Building for Production

To build the static site for production:

cd app
hugo --minify

The generated site will be in the app/public/ directory.

Deployment

The site can be deployed to various platforms:

• GitHub Pages: Use GitHub Actions workflow
• Netlify: Connect your repository and set build command to cd app && hugo --minify
• Vercel: Similar to Netlify
• Docker: Use the included Dockerfile

Docker Deployment

Build and run with Docker:

docker build -t docs-site .
docker run -p 8080:80 docs-site

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Adding or refreshing a Hub documentation page

The repeatable recipe for adding a new page under app/content/docs/hub/ — or for refreshing an existing one when the Hub frontend changes — is documented in TEMPLATE.md. It covers:

• where to look in the monorepo (hub-frontend, hub-api and the hub-pipeline-* services) for the source of truth behind each feature,
• the canonical page structure used by the existing pages,
• how to write a Playwright spec that regenerates every screenshot against a locally-running Hub stack (hub-api + hub-frontend on http://localhost:4200), starting from playwright/tests/TEMPLATE.spec.ts.example.

The Cases (docs/hub/cases) and Live view (docs/hub/livestream) pages are both written against that template and can be used as copy/paste references.

Resources

• Hugo Documentation
• Hextra Theme Documentation
• Markdown Guide

License

[Add your license here]

Support

For issues and questions, please open an issue on GitHub.