Documentation

🚀 Getting Started

Quick start guide to set up your ShowroomOS workspace, configure your first template, and onboard tenants.

Sign up for 15-day preview
Explore template gallery
Create your first tenant
Customize branding and content

Start Preview →

📐 Template Management

Learn how to create, edit, and publish templates. Master the Template Wizard and advanced HTML/CSS editor.

Template Wizard walkthrough
HTML/CSS editor best practices
Validation rules and safety checks
Preview and test templates

Learn More →

🏛️ Enterprise Governance

Complete guide to version control, visual diffs, tenant impact analysis, and staged rollouts.

Version history and changelog
Visual diff viewer (HTML, CSS, JSON)
Publish gates and safety rules
Scheduled and staged publishing

View Features →

🎨 Tenant Customization

How tenants customize their storefront without breaking the template. Safe content and branding overrides.

Homepage content editor
Branding controls (logo, colors, fonts)
Category sorting and organization
What tenants cannot customize (HTML/CSS)

Try It Out →

🔌 API Reference

REST API documentation for programmatic template management, tenant operations, and webhook integrations.

Authentication and authorization
Template CRUD operations
Tenant management endpoints
Webhook event types (planned)

[Coming Soon]

🔒 Security & Compliance

Security architecture, compliance standards, and best practices for protecting your multi-tenant platform.

No tenant-provided JavaScript
Sandboxed preview environment
Role-based access control
Audit logs and compliance

View Security Details →

Key Concepts

What is a Template?

A template is a complete storefront design that controls the HTML and CSS for three core pages: Home, Catalog, and Item Detail. Templates are created and managed by Platform Owners and assigned to tenants.

Example: The "Luxury Boutique" template uses serif fonts, gold accents, and elegant spacing. When assigned to a tenant, their storefront adopts this design instantly.

What Can Tenants Customize?

Tenants can customize content and branding without touching HTML or CSS:

Content: Homepage hero text, CTA buttons, footer text, meta titles
Branding: Logo, favicon, primary/secondary colors, fonts, border radius, spacing scale
Organization: Category sorting and display order

What tenants cannot do: Upload custom HTML, inject JavaScript, modify CSS directly, or break template structure.

How Does Version Control Work?

Every template change creates a new version. You can compare versions side-by-side using the Visual Diff viewer, which shows:

HTML changes for Home, Catalog, and Item pages
CSS modifications (additions, deletions, changes)
Token JSON changes (design system values)
Content JSON changes (default text)

Before publishing, you'll see which tenants are affected, their risk scores, and potential conflicts. You can schedule publishes for off-hours or roll out gradually using staged rollouts.

What is a Staged Rollout?

A staged rollout publishes a template version to tenants in phases. You can choose:

Risk-Based: Publish to low-risk tenants first, then medium, then high
Percentage-Based: Publish to 10%, then 25%, then 50%, then 100%

If issues arise, you can pause the rollout, investigate, and resume or abort. You can also instantly rollback to the previous version.

Documentation FAQ

Where can I find the full API documentation?

Full REST API documentation is coming soon. For now, please contact our support team for API access and integration guidance.

Can I export my template code?

Yes, you can export the HTML, CSS, and JSON for any template version from the template editor. This is useful for backups and external version control.

How do I test a template before publishing?

Use the sandboxed preview environment in the template editor. You can preview how the template looks with different tenant customizations without affecting live storefronts.

What happens if a tenant has customizations that conflict with a new template version?

The Tenant Impact Intelligence panel will flag the conflict before you publish. You can preview the tenant's storefront with the new version, adjust the template or tenant overrides, or exclude that tenant from the rollout.

Can I schedule template publishes for off-peak hours?

Yes! Scheduled publishing is available on Pro and Enterprise plans. Choose a date and time (UTC), and the template will automatically publish at that time.

How long are audit logs retained?

Audit logs (publish, rollback, and rollout actions) are retained for 90 days on Pro plans and 1 year on Enterprise plans. Export functionality for compliance is coming soon.