Naming for technical docs vs legal
Technical documentation in this monorepo follows the neutral rules in the internal documentation style guide (source file docs/src/content/docs/internal/documentation-style-guide.md). Summarised here:
Technical prose (default)
| Dimension | What to write | Notes |
|---|---|---|
| Product / platform | SaaS ERP or “multitenant SaaS ERP platform” | Avoid vendor marketing names in body text. |
| Public hosts | Placeholders: PRIMARY_WEB_DOMAIN, ADMIN_WEB_HOST, GATEWAY_PUBLIC_URL | Describe roles (“marketing site”, “admin web”), not production DNS strings. |
| Source control | GITHUB_ORG, MONOREPO_NAME, GATEWAY_REPO | Keep literal https://github.com/... URLs only in optional Contributor appendix sections if required. |
| Identifiers in code | Verbatim in fenced code or inline `...` | Environment keys, Wrangler names, package scopes must stay copy/paste accurate. |
Legal and customer-facing (exception)
Contracts, invoices, registered company names, and customer-visible marketing copy do not follow the technical neutral rules above. Use the legal entity name, registered domains, and approved product name supplied by your organisation. Those materials are out of scope for this Starlight engineering tree unless explicitly labelled.
Legacy repository names (ERP app)
Historical planning titles may still mention older Frappe app repository labels. For new technical prose, refer to the ERP app repository by its current directory / import name in this workspace (prego_saas style) without repeating vendor marketing strings in narrative sentences.
Related
- Fork-ready platform hub
- Repository README index — role-based list of repositories (replace owner segments with your
GITHUB_ORGfork when applicable). - Documentation style guide