help

package
v1.801.150 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package help declares the Hanzo Help Center (Frappe Helpdesk-core) model as DocType fixtures on the framework engine (clients/framework). Like clients/cms it is NOT a bespoke subsystem and mounts NO HTTP surface of its own: a ticket IS a framework document in module "help", its lifecycle IS a status field, an agent / team / SLA / canned response are framework documents, and CRUD + permissions + tenant isolation + install + rendering are the framework's generic, already-live surface (/v1/framework/*) and the SAME generic @hanzo/ui DocType renderer that draws CMS and ERP.

Help is the THIRD app lane and the purest proof of the thesis: it is fixtures and nothing else — ZERO Go behavior (no hooks) and ZERO console UI (the generic renderer scoped to module=help). A whole support desk becomes "just DocTypes".

Names are slug-style with an "hd-" prefix, so they never collide with the CMS (Author/Media/Page/…) or ERP (erp-*) lanes and never carry a space the console's `/cloud` path filter would reject. Tickets use a monotonic series name ("hd-tkt-.#####"); the masters use a field autoname the console slugifies on write.

Index

Constants

View Source
const Module = "help"

Module is the framework module tag every Help DocType carries. The console's Help surface is the generic DocType renderer scoped to this module.

View Source
const RoleHelpAgent = "Help Agent"

RoleHelpAgent is the support role the Help DocTypes grant read/write/create/ delete. The org owner (System Manager, seeded trust-on-first-use) assigns it via /v1/framework/roles; a role-less member stays denied (secure by default).

Variables

This section is empty.

Functions

func DocTypes

func DocTypes() []framework.DocType

DocTypes returns the canonical Help Center model. Masters (agent/team/SLA) come first for readability; the engine resolves Link targets at document write, so the ticket may reference an agent/team/SLA defined here in any order.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL