Deployment Models¶
AIERP documentation should support both public and customer-hosted deployments.
Recommended Public Setup¶
- live product application:
pos-v2.aabhat.com - documentation site:
docs.aierp.aabhat.com
This keeps the product surface and the documentation surface separate, which is cleaner for navigation, caching, and security policy.
Customer Environment Options¶
Option 1: Internal docs subdomain¶
Use a customer-specific internal hostname like:
docs.customer.internalaierp-docs.customer.example
Best when the customer wants internal-only access and separate auth policy.
Option 2: Mounted under the platform¶
Serve the built MkDocs site under:
/docs
Best when the customer wants a single platform URL and shared ingress rules.
Option 3: No deployed docs site¶
If a customer does not want hosted docs at all, the generated site can still be:
- bundled as an artifact
- shared as static HTML
- published only in internal delivery tooling
Decision Guide¶
| Need | Recommended model |
|---|---|
| Public product documentation | docs.aierp.aabhat.com |
| Existing application already uses a subdomain | keep the app where it is, put docs on a separate subdomain |
| Private customer-only deployment | internal docs host or /docs |
| Highly locked-down environment | build static docs and serve locally |
Current Recommendation¶
For AIERP, use:
docs.aierp.aabhat.comfor the public-facing docs experience/docsfor customer-hosted installs when needed
That gives you one docs codebase and two deployment modes.