digiDocs/CLAUDE.md
dbits-db 5f3fd67a41
Some checks failed
Regenerate Documentation Index / regenerate-index (push) Failing after 7s
Update CLAUDE.md with joeyking docs tool documentation
2026-01-28 20:07:21 -04:00

6.4 KiB

digiDocs

digiBandit Public Documentation - Customer-facing documentation synced to dbits.ca/docs.

Last Updated: 2026-01-28

Inherits from: /run/media/deck/Storage/2026/CLAUDE.md - See root for Quick Start, Model Optimization, Agent Profiles, and Session Orchestration System.


Guidelines

  • "git" = git.dbits.ca (Forgejo): All repos at git.dbits.ca/digiBandit/ (exception: xdmu uses GitHub for CI/CD)
  • Maintain CLAUDE.md: Update this file when workflows change, issues are discovered, or new patterns are established
  • No Co-Authored-By: Do not include Co-Authored-By: Claude... in commit messages
  • Documentation Sync: Keep CLAUDE.md, README.md, and _config.yml in sync
  • Public Content: This repo is customer-facing - avoid internal details, credentials, or sensitive information

Session Documentation (AUTOMATIC)

MANDATORY: At the end of every significant session, Claude MUST automatically:

  1. Save a session summary to session-logs repo
  2. Commit and push to git.dbits.ca

Do not wait to be asked. When the user says "done", "close", "that's it", or ends the session - automatically document and push.

# Session summary location
/run/media/deck/Storage/2026/session-logs/YYYY/MM/YYYY-MM-DD-brief-title.md

# Commit and push
cd /run/media/deck/Storage/2026/session-logs && git add . && git commit -m "Session: [description]" && git push

See the root CLAUDE.md for full session documentation template and ITFlow ticket workflow.


Overview

Field Value
URL dbits.ca/docs
Repo git.dbits.ca/digiBandit/digiDocs
Type Public documentation (Markdown)
Doc Count 82 documents
Index .docs-index.json

Documentation Metadata

All documents include YAML frontmatter for joeyking search optimization:

---
title: Document Title
description: One-line summary for search results
category: services|legal|backup|security|getting-started|products|policies|about
tags: [tag1, tag2, tag3]
---

Machine-Readable Index

.docs-index.json provides a searchable index of all documents:

{
  "version": "1.0",
  "repo": "digiDocs",
  "generated": "2026-01-28T12:00:00Z",
  "doc_count": 73,
  "docs": [
    {
      "path": "Services/Device_Management.md",
      "title": "Device Management",
      "description": "Core device management services and tiers",
      "category": "services",
      "tags": ["device", "services"],
      "audience": "customer"
    }
  ]
}

Tag Taxonomy

Category Common Tags
services mits, rmm, backup, security, monitoring, helpdesk, device, network
legal msa, warranty, agreement, terms, policy
backup disaster-recovery, databack, continuity, restore
security edr, huntress, pam, training, compliance, ransomware
products voip, google-workspace, bitwarden, mdm, databack
getting-started onboarding, setup, portal, new-client
policies byod, acceptable-use, password, compliance

Structure

digiDocs/
├── .docs-index.json      # Machine-readable doc index (for joeyking)
├── _config.yml           # Jekyll/docs site config
├── CLAUDE.md             # Project instructions
├── README.md             # Repo overview
├── About/                # Company information (1 doc)
├── Backup/               # Backup procedures (4 docs)
├── Getting Started/      # Onboarding docs (8 docs)
├── Legal/                # Terms, privacy, agreements (5 docs)
├── Policies/             # Service policies (7 docs)
├── Products/             # Product documentation (9 docs)
├── Security/             # Security guides (6 docs)
├── Services/             # Service documentation (29 docs)
└── .github/              # GitHub workflows (legacy)

Each folder contains a README.md with a table of contents.


Content Guidelines

  • Use clear, customer-friendly language
  • Include step-by-step instructions where applicable
  • Avoid technical jargon unless necessary
  • Keep documents focused and concise
  • Use markdown formatting consistently

joeyking - Central AI Brain

jk.dbits.ca is the central Claude brain. See root CLAUDE.md for full details.

  • Query business data: ITFlow tickets/clients, TRMM agents/scripts, Forgejo repos
  • Search documentation: Semantic search across digiDocs and digiDocs_internal
  • Trigger automations: n8n workflows, TRMM script execution
  • Shared context: Cross-session memory and state
  • API: https://jk.dbits.ca/api/tool

Docs Search Tool

joeyking provides semantic documentation search via the docs tool:

# Search by category
joeyking.sh docs search_docs '{"repo": "digiDocs", "category": "security"}'

# Search by keyword
joeyking.sh docs search_docs '{"repo": "digiDocs", "keyword": "backup"}'

# Search with tags
joeyking.sh docs search_docs '{"repo": "digiDocs", "tags": ["mits", "services"]}'

# Combined search
joeyking.sh docs search_docs '{"repo": "digiDocs", "category": "services", "keyword": "device", "limit": 5}'

# Get full document content
joeyking.sh docs get_doc '{"repo": "digiDocs", "path": "Services/Device_Management.md"}'

# List categories with counts
joeyking.sh docs list_categories '{"repo": "digiDocs"}'

# List tags with counts
joeyking.sh docs list_tags '{"repo": "digiDocs"}'

Operations:

Operation Description
search_docs Search by category, tags, and/or keyword
get_doc Get full document content with metadata
list_categories List all categories with doc counts
list_tags List all tags with usage counts

Other joeyking Tools

# List available tools
joeyking.sh tools

# ITFlow queries
joeyking.sh itflow get_ticket '{"ticket_id": "t260045"}'
joeyking.sh itflow list_clients

# TRMM queries
joeyking.sh trmm list_agents '{"client_name": "ClientName"}'

# Forgejo queries
joeyking.sh forgejo list_repos
joeyking.sh forgejo get_file '{"repo": "digiDocs", "path": "README.md"}'

# Cross-session context
joeyking.sh context get

Task Orchestration

See root CLAUDE.md for full details. For any non-trivial work:

  • Use TaskCreate/TaskUpdate to track work
  • Check task prerequisites before starting
  • Spin up sub-agents via Task tool for parallel work
  • Report progress to Dalton throughout

digiBandit Ecosystem

See /run/media/deck/Storage/2026/CLAUDE.md for full ecosystem overview.