Arcane Support Knowledge Base

This folder contains support-focused knowledge intended for AI-assisted ticket draft replies.

Structure

  • legal/: normalized Markdown versions of legal policies.
  • guides/: generated Markdown from Discord guide content mirror files.
  • user-guides/: manually curated user-facing Q&A docs derived from product behavior in code. This is also where support troubleshooting playbooks live (for example outage/server-down guidance used by AI drafts).

Source of Truth

  • Legal pages:
  • arcane-web/app/legal/refunds/page.tsx
  • arcane-web/app/legal/terms/page.tsx
  • arcane-web/app/legal/privacy/page.tsx
  • Guide content:
  • Arcane.Orchestrator/GuideContent/*.guide.json

Updating the KB

When guide content changes, regenerate guide Markdown:

./scripts/sync-support-kb-guides.sh

Legal Markdown files should be updated whenever legal page content changes.

Manual docs in user-guides/ are not generated and should be edited directly.

Internal Site (MkDocs)

This KB can be served as a lightweight internal website from the support-kb container.

  • Internal URL (default): http://<server>:8081
  • Docker Compose service: support-kb
  • Default bind address: 127.0.0.1 (override with SUPPORT_KB_BIND=0.0.0.0 if needed)

Local Build

docker build -t arcane-support-kb ./docs/support-kb
docker run --rm -p 8081:80 arcane-support-kb

Public Domain

To publish this KB at https://docs.arcane-services.xyz, use the deployment runbook in:

  • docs/support-kb/deploy/README.md