cf3d7ef7e2
- Removed all Day X Exercise training activities - Removed training-focused language from foreword - Renamed from Client_Portal_Training_Guide to Client_Portal_Guide - Now serves as reference documentation, not training curriculum
83 lines
2.6 KiB
Markdown
83 lines
2.6 KiB
Markdown
# digiDocs
|
|
|
|
**digiBandit Public Documentation** - Customer-facing documentation synced to dbits.ca/docs.
|
|
|
|
**Last Updated**: 2026-01-27
|
|
|
|
> **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 | ~68 documents |
|
|
|
|
---
|
|
|
|
## Structure
|
|
|
|
```
|
|
digiDocs/
|
|
├── _config.yml # Jekyll/docs site config
|
|
├── README.md # Repo overview
|
|
├── About/ # Company information
|
|
├── Backup/ # Backup procedures
|
|
├── Getting Started/ # Onboarding docs
|
|
├── Legal/ # Terms, privacy, agreements
|
|
├── Policies/ # Service policies
|
|
├── Products/ # Product documentation
|
|
├── Security/ # Security guides
|
|
├── Services/ # Service documentation
|
|
└── .github/ # GitHub workflows (legacy)
|
|
```
|
|
|
|
---
|
|
|
|
## 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
|
|
|
|
---
|
|
|
|
## digiBandit Ecosystem
|
|
|
|
See `/run/media/deck/Storage/2026/CLAUDE.md` for full ecosystem overview.
|