53 lines
3.5 KiB
Markdown
53 lines
3.5 KiB
Markdown
# DBK Platform Documentation Migration
|
|
|
|
## Status
|
|
|
|
The canonical platform identity is **DBK Platform**. **HomAroma is the reference
|
|
tenant**. This manifest governs the conversion of legacy documentation without
|
|
rewriting operational history or accidentally renaming runtime infrastructure.
|
|
See [Platform Overview](PLATFORM_OVERVIEW.md) for terminology.
|
|
|
|
## Completed: platform identity pass and scope labeling
|
|
|
|
- `PROJECT_DETAILS.md`
|
|
- `PROJECT_SYSTEM_SUMMARY.md`
|
|
- `PROJECT_MANAGEMENT_PERSPECTIVE.md`
|
|
- `LLM_MCP_GUIDE.md`
|
|
|
|
These documents now introduce DBK Platform before mentioning HomAroma and explain
|
|
the platform/tenant boundary.
|
|
|
|
## Classification record
|
|
|
|
| Classification | Files | Required treatment |
|
|
| --- | --- | --- |
|
|
| Platform capability and architecture | `ARCHITECTURE_DECISIONS.md`, `CUSTOM_BLOCK_FLOW_GUIDE.md`, `ADMIN_MCP_SECTION_GUIDE.md`, `PRISMA7_GUIDE.md`, `mcp_update.md`, `implementation_plan.md`, `frontend-comparison.md`, `BUSINESS_ANALYTICS_MAPS_PLAN.md`, `goal.section.md` | Rewrite product claims in vertical-neutral language. Keep real technical contracts and implementation details. |
|
|
| Tenant examples and content | `PRODUCT_JSON_IMPORT_SCHEMA.md`, `LLM_PRODUCT_JSON_GENERATOR_GUIDE.md`, `LLM_PROMPT_1_WELLNESS_LUXURY.md`, `LLM_PROMPT_2_BEAUTY_MULTIBRAND.md`, `LLM_PROMPT_3_FASHION_LIFESTYLE.md`, `LLM_PROMPT_4_MOTO_PARTS.md`, `docs/notifications/*`, `docs/policies/*`, `docs/tenants/**/*`, `TEST_INFRA.md` | Name the tenant at the start. Preserve product copy, sample data, and URLs as tenant examples. |
|
|
| Deployment and operations | `DEPLOYMENT_GUIDE.md`, `DDC_DEPLOYMENT_RUNBOOK.md`, `HUAHIN_DEPLOYMENT_RUNBOOK.md`, `KITTISAK_DEPLOYMENT_RUNBOOK.md`, `TENANT_PROVISIONING_POSTMORTEM_CHECKLIST.md` | Add a scope label. Preserve domains, hosts, process names, commands, and incident facts exactly unless an infrastructure migration is approved. |
|
|
| Historical records | `ORIGINAL_REQUEST.md`, `RESUME_PORTFOLIO_MARKETING_DEV.md` | Preserve the original content. Add a concise historical-context notice only if a reader could mistake it for current product documentation. |
|
|
| Developer instructions and local tool docs | `AGENTS.md`, `apps/website/AGENTS.md`, `apps/mcp-server/README.md`, `.agents/skills/**/*` | Update only after validating the referenced workflow against current code and owners. These files influence agent behavior, so they require a review gate. |
|
|
|
|
## Editing rules
|
|
|
|
1. Never replace every occurrence of `HomAroma`; decide whether it is a tenant,
|
|
historical name, or runtime identifier first.
|
|
2. Use **DBK Platform** for shared architecture, capabilities, and product
|
|
positioning.
|
|
3. Use **HomAroma** only when the document refers to the reference tenant,
|
|
HomAroma-specific content, or a legacy operational identifier.
|
|
4. Label examples with their tenant and vertical.
|
|
5. Do not claim a channel or integration is enabled for every tenant unless it is
|
|
enforced by a shared contract.
|
|
6. Treat paths, domains, PM2 names, package names, database names, storage keys,
|
|
and environment variables as a separate infrastructure migration.
|
|
|
|
## Acceptance checks
|
|
|
|
- A reader can identify whether a document describes the platform, a tenant, or
|
|
historical/operational context from its heading or opening note.
|
|
- No current overview describes DBK Platform as aroma-only.
|
|
- Tenant-specific product data is not presented as a mandatory platform schema or
|
|
capability.
|
|
- Historical operational data remains traceable and unchanged in meaning.
|
|
- Markdown links and `git diff --check` pass before handoff.
|