Documentation Module

Product manuals, safety guides, and searchable knowledge base for your customers through a branded public portal.

Overview

The Documentation module provides a branded knowledge center for your products. Customers access documentation through a public portal or via QR codes on product packaging.

• Upload and organize PDF manuals by product and category
• Create searchable knowledge articles with rich media
• Full-text search across all documents
• Version control for document revisions
• Multi-language support for localized content
• QR code integration for product-specific documentation
• Branded portal with your logo and colors

Content Types

Key Features

Public Portal

Customers access documentation at app.proign.com/{tenant}/docs. The portal includes:

• Category-based navigation with breadcrumbs
• Full-text search with highlighted results
• Product-specific documentation pages
• Responsive design for mobile access via QR scans
• Branded header, footer, and color scheme

Version Control

Maintain multiple versions of documents with full revision history:

• Versioned Uploads — Upload new revisions of a document while keeping previous versions accessible
• Active Version — Only one version is active (shown to customers) at a time; switch with a single click
• Change Log — Each version includes a description of what changed
• Rollback — Revert to any previous version instantly

Full-Text Search

Search across all document types with Cloudflare D1 full-text indexing:

• Searches titles, descriptions, article body text, and tags
• PDF content is indexed on upload for searchability
• Results ranked by relevance with matching text highlighted
• Filters by category, product, content type, and language

Multi-Language Support

Serve documentation in multiple languages:

• Language Variants — Upload separate documents per language (e.g., manual_en.pdf, manual_de.pdf)
• Article Translations — Knowledge articles support inline translation fields per language
• Auto-Detection — Portal detects browser language and serves the appropriate version
• Fallback — Falls back to default language (English) when translation is unavailable

API Endpoints

Documents

GET    /api/[tenant]/documents              # List documents with filters
GET    /api/[tenant]/documents/[id]         # Get document details
POST   /api/[tenant]/documents              # Create document (admin)
PATCH  /api/[tenant]/documents/[id]         # Update document (admin)
DELETE /api/[tenant]/documents/[id]         # Delete document (admin)

Categories

GET    /api/[tenant]/categories             # List categories
POST   /api/[tenant]/categories             # Create category (admin)
PATCH  /api/[tenant]/categories/[id]        # Update category (admin)
DELETE /api/[tenant]/categories/[id]        # Delete category (admin)

Search

GET    /api/[tenant]/search?q={query}       # Full-text search
GET    /api/[tenant]/search?q={query}&category={id}&lang={code}  # Filtered search

Media & Versions

POST   /api/[tenant]/documents/[id]/upload   # Upload document file (PDF)
GET    /api/[tenant]/documents/[id]/versions # List document versions
POST   /api/[tenant]/documents/[id]/versions # Upload new version
PATCH  /api/[tenant]/documents/[id]/versions/[v] # Set active version

Public API

GET    /api/p/[tenant]/docs                 # Public document listing
GET    /api/p/[tenant]/docs/[slug]          # Public document page
GET    /api/p/[tenant]/docs/search?q={q}    # Public search

Request Examples

Create Document

POST /api/[tenant]/documents
Content-Type: application/json
Authorization: Bearer <admin-jwt>

{
  "title": "TP9 Elite SC Owner's Manual",
  "slug": "tp9-elite-sc-manual",
  "type": "manual",
  "category_id": "cat_handguns",
  "product_ids": ["prod_tp9elite"],
  "language": "en",
  "description": "Complete owner's manual including safety, operation, and maintenance",
  "tags": ["manual", "safety", "maintenance"]
}

// Response (201 Created)
{
  "data": {
    "id": "doc_abc123",
    "title": "TP9 Elite SC Owner's Manual",
    "slug": "tp9-elite-sc-manual",
    "status": "draft",
    "version": 1,
    "created_at": "2026-02-21T10:00:00Z"
  }
}

Search Documents

GET /api/p/[tenant]/docs/search?q=cleaning+guide&lang=en

// Response
{
  "data": [
    {
      "id": "doc_xyz789",
      "title": "Cleaning & Maintenance Guide",
      "type": "article",
      "category": "Maintenance",
      "snippet": "...proper <mark>cleaning</mark> procedure for your firearm...",
      "relevance": 0.95
    }
  ],
  "total": 3
}

Integration with Other Modules

• QR Codes — Link QR codes directly to product-specific documentation pages. Customers scan a QR on the product packaging and land on the relevant manual.
• Support — Agents can reference and link documentation articles in support ticket responses.
• Aftersale — Warranty terms and service guides are accessible from the aftersale portal.
• SDS — Cross-reference safety data sheets for chemical-related products.

Related