Skip to content

faq.md

Latest commit

 

History

History
95 lines (67 loc) · 1.67 KB

faq.md

File metadata and controls

95 lines (67 loc) · 1.67 KB

FAQ System Design

This document defines how FAQs are stored, identified, and managed inside OmegaBot.

The goal is to keep FAQs:

  • Easy to manage
  • Safe for Discord limits
  • Auditable
  • Persisted in SQLite with the rest of OmegaBot state

Table of Contents

Storage Model

FAQs are stored in SQLite in the faqs table.

The database is the single source of truth for FAQ entries. FAQ tags are stored as JSON text inside the tags column, but the store itself is not file-backed.

FAQ Entry Schema

Each FAQ entry follows this schema:

type FaqEntry = {
  key: string;
  title: string;
  body: string;
  tags: string[];
  createdAt: string;
  updatedAt: string;
  createdBy: string;
  updatedBy: string;
  usageCount: number;
};

type FaqStore = {
  version: 1;
  entries: Record<string, FaqEntry>;
};

Key Format and Limits

  • Lowercase only
  • Letters, numbers, and dashes only
  • No spaces
  • Immutable once created
  • Max length: 48 characters

Size Limits

Field Limit
title 80 chars
body 4000 chars
tags 10 max

Command Expectations

  • /faq add validates input and initializes metadata
  • /faq get increments usage count
  • /faq list shows keys + titles
  • /faq remove deletes entry (permission-gated)

Future Plans

  • Database storage
  • Search
  • Role-based visibility
  • Audit history

FAQs are treated as shared operational knowledge.