# HPCE Documentation

This site contains internal documentation of HCPE services at Paul Scherrer
Institute, particularly the *Merlin 6* and *Merlin 7* clusters.  Live pages are
available at <https://hpce.pages.psi.ch>.

## Development

### Using Docker Compose (Recommended)

```bash
# Start the development server
docker compose up

# Or run in background
docker compose up -d
```

The documentation will be available at `http://localhost:8000`.

> [!NOTE]
> We use several MkDocs plugins, which need to be installed by hand. We do this by
> using a Dockerfile that pulls in the `squidfunk/mkdocs-material` image and runs
> some `pip install` commands. This means that on the first `compose up` call, a
> new docker image will be built locally on your machine.

### Deployment

The site is automatically deployed to `https://hpce.pages.psi.ch/` via Gitea Pages.

## Contributing

Please follow established conventions when adding new documentation:

1. Use clear, descriptive filenames
2. Follow the existing directory structure
3. Include appropriate metadata in frontmatter
4. Test locally before committing

## Repository Structure

TBD

## Contact

For questions or issues with this documentation, contact the HPCE team.

## License

Theme content is licensed under the MIT license.