digiDocs/CLAUDE.md
dbits-db a9fc9bc400
Some checks failed
Deploy to GitHub Pages / build (push) Failing after 3s
Deploy to GitHub Pages / deploy (push) Has been skipped
Add documentation metadata system for joeyking search
- Add .docs-index.json machine-readable index (73 docs)
- Add YAML frontmatter to all documentation files
- Add README.md to each folder with table of contents
- Update CLAUDE.md with metadata schema documentation
2026-01-28 17:46:50 -04:00

182 lines
5.6 KiB
Markdown

# 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`](../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.
```bash
# 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 | 73 documents |
| Index | `.docs-index.json` |
---
## Documentation Metadata
All documents include YAML frontmatter for joeyking search optimization:
```yaml
---
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:
```json
{
"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
- **Trigger automations**: n8n workflows, TRMM script execution
- **Shared context**: Cross-session memory and state
- **API**: `https://jk.dbits.ca/api/tool` (coming soon for Claude Code integration)
### Using joeyking CLI
Query business systems directly from Claude Code:
```bash
# List available tools
/run/media/deck/Storage/2026/joeyking.sh tools
# ITFlow queries
/run/media/deck/Storage/2026/joeyking.sh itflow get_ticket '{"ticket_id": "t260045"}'
/run/media/deck/Storage/2026/joeyking.sh itflow list_clients
# TRMM queries
/run/media/deck/Storage/2026/joeyking.sh trmm list_agents '{"client_name": "ClientName"}'
# Forgejo queries
/run/media/deck/Storage/2026/joeyking.sh forgejo list_repos
/run/media/deck/Storage/2026/joeyking.sh forgejo get_file '{"repo": "digiDocs", "path": "README.md"}'
# Cross-session context
/run/media/deck/Storage/2026/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.