Example Retail Energy Provider¶
Welcome to the internal documentation for the Example Retail Energy Provider platform (organization slug examplerep). This site is a behind-the-scenes view of how we structure software, run services, and document decisions — it is not a customer-facing marketing site.
What you will find here¶
| Section | Purpose |
|---|---|
| Overview | Why this platform exists and how to navigate these docs. |
| Platform | Architecture, repository naming, and how systems connect. |
| Development | How to run this documentation locally and where to find engineering standards. |
Audience¶
This site is written for engineers, operators, and partners who build or extend examplerep systems. For public or product information, use other channels (for example, examplerep.com when published).
Quick links¶
- Mission & scope — goals and boundaries of the program.
- Repositories & naming — prefixes such as
api-,portal-,gitops-, andiac-. - How to use this site — editing and publishing workflow.
Contributing to this docs repo¶
Changes are made in the web-examplerep-project repository. The site is built with MkDocs and the Material for MkDocs theme, and published to GitHub Pages when changes land on the default branch. See Local documentation for the exact commands.