Contribute

REG-1 documentation site uses MkDocs, a static site generator geared towards (technical) project documentation and a readily available theme named Material for MkDocs.

Prerequisites

pip install mkdocs
pip install mkdocs-material

Local Preview

1. Clone the reg-1.github.io GitHub repository.

2. Add a new page or update an existing one using the markdown language.

3. Start the built-in dev-server from the root of the cloned repository with mkdocs serve.

4. Preview your documentation locally at http://127.0.0.1:8000.

Publish Changes

1. Push your changes to a feature branch and merge it into the main branch of the reg-1.github.io GitHub repository once approved. This will automatically trigger the following preconfigured GitHub Actions workflows:

   • Continuous Integration
   • Pages Build and Deployment

2. Access the documentation site at https://docs.service.reg-1.com.