How to use this site

Who this is for

Use this site when you need to understand how examplerep repositories fit together, how to name new work, or where to run tooling locally. It is maintained by the same team that builds the platform.

How content is organized

• Overview — Context and scope.
• Platform — Architecture, repositories, and how we expose services (domains, URLs).
• Development — Running this MkDocs project locally and references to coding standards.

Editing

1. Clone the web-examplerep-project repository.
2. Create a branch and edit Markdown files under docs/.
3. Preview locally (see Local documentation).
4. Open a pull request; after merge to the default branch, GitHub Actions publishes the site to GitHub Pages.

GitHub Pages

• Project site URL: https://examplerep.github.io/web-examplerep-project/
• Ensure the repository Pages settings use the gh-pages branch (created by mkdocs gh-deploy in CI).

If you add a custom domain later, update site_url in mkdocs.yml and configure DNS and GitHub Pages accordingly.

Style notes

• Prefer short pages with clear headings.
• Use tables for comparisons; keep columns aligned in the source for readability.
• Link to other repositories or external docs instead of duplicating long procedures.