Domains & URLs¶
Public web¶
| Domain | Intended use |
|---|---|
| examplerep.com | Public web presence and product-facing properties when published. |
Documentation (this site)¶
| URL | Purpose |
|---|---|
| GitHub Pages project site | https://examplerep.github.io/web-examplerep-project/ |
After publishing, confirm Repository → Settings → Pages uses the gh-pages branch.
APIs and environments¶
Patterns for APIs and environments vary by team. Common conventions:
| Pattern | Example | Notes |
|---|---|---|
| Environment in hostname | api.dev.examplerep.com |
Coordinate with DNS and ingress. |
| Path prefix | https://api.examplerep.com/account/v1 |
Version in path for REST. |
Document actual hostnames and paths here once they are fixed for each service.
Custom domain for docs (optional)¶
To serve this site from a subdomain such as docs.examplerep.com:
- Add the custom domain in GitHub Pages settings.
- Update
site_urlinmkdocs.ymlto match. - Re-deploy so generated links and canonical URLs stay correct.