x
This commit is contained in:
Your Name committed
1 parent
7abbcfebd2
commit
0ceee3dbff
46 files changed
+226
-31
No files matched your search
@@ -0,0 +1,52 @@
|
||||
# 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.
|
||||
@@ -0,0 +1,52 @@
|
||||
# DBK Platform Overview
|
||||
|
||||
## Purpose
|
||||
|
||||
DBK Platform is a multi-tenant, white-label commerce platform. It provides the
|
||||
shared capabilities required to operate branded commerce experiences across web,
|
||||
social-commerce, administrative, and marketplace channels. It is not limited to
|
||||
one product vertical.
|
||||
|
||||
## Product model
|
||||
|
||||
| Term | Meaning |
|
||||
| --- | --- |
|
||||
| **DBK Platform** | The shared product, architecture, applications, and operational capabilities in this repository. |
|
||||
| **Tenant** | A separately branded commerce implementation using the platform. A tenant owns its brand, catalog, content, domains, integrations, and configuration. |
|
||||
| **Reference tenant** | A concrete tenant retained as an implementation and content reference. |
|
||||
| **HomAroma** | The reference tenant for aroma, essential-oil, and home-fragrance commerce. It is not the platform's product category. |
|
||||
| **Legacy identifier** | Existing repository names, hosts, PM2 processes, domains, storage keys, and deployment paths that contain `homaroma`. These are operational identifiers until explicitly migrated. |
|
||||
|
||||
## Shared applications
|
||||
|
||||
- `apps/backend`: API, commerce domain logic, persistence, tenant-aware configuration, and integrations.
|
||||
- `apps/admin`: back-office operations and content/commerce management.
|
||||
- `apps/website`: server-rendered public storefront with SEO support.
|
||||
- `apps/spa`: mobile and social-commerce storefront, including LINE LIFF where enabled by a tenant.
|
||||
- `apps/mcp-server`: MCP interface for supported content and administration workflows.
|
||||
- `packages/types`: shared TypeScript contracts.
|
||||
|
||||
## Documentation rules
|
||||
|
||||
1. Platform documents must describe capabilities in vertical-neutral language.
|
||||
2. Tenant documents must name the tenant and may use vertical-specific products,
|
||||
copy, images, routes, domains, or integrations.
|
||||
3. Examples must identify their tenant; they must not imply that their catalog is
|
||||
a platform requirement.
|
||||
4. Historical records retain their original names and claims, but must carry a
|
||||
short historical-context note when they could be mistaken for current platform
|
||||
documentation.
|
||||
5. A legacy infrastructure identifier is not evidence of current product branding.
|
||||
|
||||
## Current tenants and examples
|
||||
|
||||
HomAroma is the reference tenant. The repository also contains tenant or showcase
|
||||
material for wellness, beauty, fashion, motorcycle parts, and other deployments.
|
||||
Their presence demonstrates that DBK Platform supports multiple verticals; it does
|
||||
not guarantee that every documented integration is enabled for every tenant.
|
||||
|
||||
## Migration boundary
|
||||
|
||||
This documentation migration does not rename runtime identifiers or alter code,
|
||||
database schemas, deployment paths, domains, environment variables, or external
|
||||
contracts. Such changes require a separately planned infrastructure migration.
|
||||
@@ -1,5 +1,7 @@
|
||||
# Order Confirmation Template
|
||||
|
||||
> **HomAroma reference-tenant template:** Replace brand name, voice, support details, and product-specific language for another DBK Platform tenant.
|
||||
|
||||
## English Version
|
||||
**Subject:** 🌟 Thank you for choosing HomAroma! Your order [Order ID] is confirmed.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Shipping Tracking Notification Template
|
||||
|
||||
> **HomAroma reference-tenant template:** Replace brand name, voice, support details, and product-specific language for another DBK Platform tenant.
|
||||
|
||||
## English Version
|
||||
**Subject:** 🚚 Good news! Your HomAroma order #[Order ID] is on its way.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Privacy Policy | นโยบายความเป็นส่วนตัว
|
||||
|
||||
> **Tenant policy template:** Verify and replace the tenant's legal entity, contact details, data practices, and jurisdiction before publication. This is not a platform-wide policy.
|
||||
|
||||
## English
|
||||
**Last Updated: [Date]**
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Return & Refund Policy | นโยบายการคืนสินค้าและการคืนเงิน
|
||||
|
||||
> **Tenant policy template:** Verify and replace the tenant's legal entity, product conditions, contact details, and applicable law before publication. This is not a platform-wide policy.
|
||||
|
||||
## English
|
||||
We want you to love your **HomAroma** products. If you are not completely satisfied, we are here to help.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Shipping Policy | นโยบายการจัดส่งสินค้า
|
||||
|
||||
> **Tenant policy template:** Verify and replace the tenant's delivery areas, rates, service levels, contact details, and applicable law before publication. This is not a platform-wide policy.
|
||||
|
||||
## English
|
||||
At **HomAroma**, we strive to deliver your sensory experiences as quickly and safely as possible.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Kittisak.com — Project Specification & Domain Blueprint
|
||||
|
||||
> **Tenant scope:** This specification applies to Kittisak.com only. It documents one DBK Platform tenant and must not be read as a platform default.
|
||||
|
||||
เอกสารภาพรวมโครงการ วัตถุประสงค์ทางธุรกิจ สถาปัตยกรรมระบบ และข้อมูลทางเทคนิคของโดเมน `kittisak.com`
|
||||
|
||||
---
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Brand Identity & Theme Specification — Kittisak.com
|
||||
|
||||
> **Tenant scope:** This brand, theme, and metadata specification applies only to Kittisak.com. It is not a DBK Platform default.
|
||||
|
||||
เอกสารกำหนดอัตลักษณ์ของแบรนด์ โทนสี ธีม ดีไซน์ และการตั้งค่า SEO Metadata สำหรับ `kittisak.com`
|
||||
|
||||
---
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Third-Party Integrations & Configurations — Kittisak.com
|
||||
|
||||
> **Tenant scope:** These integrations and credentials/configuration expectations apply to Kittisak.com only, not every DBK Platform tenant.
|
||||
|
||||
เอกสารบันทึกรายละเอียดการเชื่อมต่อระบบภายนอก (Third-Party Services) คีย์สภาพแวดล้อม และสถานะการเปิดใช้งานสำหรับ `kittisak.com`
|
||||
|
||||
---
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# User Flows & Operational Workflows — Kittisak.com
|
||||
|
||||
> **Tenant scope:** These journeys reflect Kittisak.com configuration and operating policy. They are not mandatory for every DBK Platform tenant.
|
||||
|
||||
เอกสารแสดงขั้นตอนการทำงานและเส้นทางประสบการณ์ผู้ใช้ (User Journeys) สำหรับ `kittisak.com`
|
||||
|
||||
---
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Website CMS Parity Plan
|
||||
|
||||
> **Platform implementation plan:** HomAroma page, content, and route references are reference-tenant parity targets unless the document explicitly describes a shared CMS contract.
|
||||
|
||||
## Goal
|
||||
Bring `apps/website` closer to the Page Builder CMS behavior already used by `apps/spa`, while preserving Next.js SSR/SEO behavior.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Website Route Parity Audit
|
||||
|
||||
> **Reference-tenant audit:** This audit compares the HomAroma reference tenant's website and SPA routes. It is not a mandatory route set for every DBK Platform tenant.
|
||||
|
||||
Scope: read-only comparison of `apps/spa/src/App.tsx` against `apps/website/src/app/**`.
|
||||
|
||||
## Route Matrix
|
||||
|
||||
Reference in new issue
Block a user