Files

Samir Boulahtit f141cc4e6a docs: migrate module documentation to single source of truth

Move 39 documentation files from top-level docs/ into each module's
docs/ folder, accessible via symlinks from docs/modules/. Create
data-model.md files for 10 modules with full schema documentation.
Replace originals with redirect stubs. Remove empty guide stubs.

Modules migrated: tenancy, billing, loyalty, marketplace, orders,
messaging, cms, catalog, inventory, hosting, prospecting.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-08 23:38:37 +01:00

2.2 KiB

Raw Permalink Blame History

Tenancy Management

Platform, merchant, store, and admin user management. Required for multi-tenant operation.

Overview

Aspect	Detail
Code	`tenancy`
Classification	Core
Dependencies	None
Status	Active

Features

platform_management — Platform-level administration
merchant_management — Merchant account management
store_management — Store configuration and setup
admin_user_management — Admin user accounts and team management

Permissions

Permission	Description
`team.view`	View team members
`team.invite`	Invite team members (owner only)
`team.edit`	Edit team members (owner only)
`team.remove`	Remove team members (owner only)

Data Model

See Data Model for full entity relationships.

Platform — Top-level SaaS instances
Merchant — Business entities that own stores
Store — Storefronts with multi-tenant scoping
User — Admin users (super_admin, platform_admin, merchant_owner, store_member)
StoreUser — Store membership with role assignment
Role — Permission roles for team members
StoreDomain / MerchantDomain — Custom domain configuration
EmailVerificationToken — Email verification tokens

API Endpoints

Method	Path	Description
`*`	`/api/v1/admin/auth/*`	Authentication (login, register, password reset)
`*`	`/api/v1/admin/merchants/*`	Merchant CRUD
`*`	`/api/v1/admin/modules/*`	Module enable/disable
`*`	`/api/v1/admin/merchant-domains/*`	Domain management
`*`	`/api/v1/admin/store-roles/*`	Admin role management
`*`	`/api/v1/store/team/*`	Team & role management
`*`	`/api/v1/store/onboarding/*`	Store onboarding wizard

Configuration

No module-specific configuration.

Additional Documentation

Data Model — Entity relationships and database schema
RBAC System — Role-based access control, permissions, pre-defined roles
Store Onboarding — 4-step onboarding wizard
Migration Plan — Code migration plan from legacy structure

2.2 KiB Raw Permalink Blame History