NOX Protocol

NOX is a structured logging system built on Markdown. This protocol defines the syntax and conventions for capturing actions, events, and decisions — in a format that’s both human-readable and machine-parsable.

Syntax Format

YYYY-MM-DD [mode:ACTION] - Message [DOMAIN] ${block: |  
  - entry 1
  - entry 2
}

Mode: Describes the type of entry — what kind of action or signal is being logged (build, log, diagnose).
Domain: The system or topic affected (HNET, PULSE, NOX).
Block: Optional structured content — logs, links, metadata, sub-tasks — formatted as a list or YAML-like structure.

NOX Modes

Mode	Description
`build`	Create something new — file, component, model, or idea.
`log`	Record what happened — facts, decisions, state changes.
`maintenance`	Refactor, rename, reorder, or remove content.
`diagnose`	Investigate, debug, or analyze issues and systems.
`plan`	Outline future actions — strategies, priorities, or goals.
`signal`	Capture a state — emotional, mental, strategic, or instinctual.

CRUD to NOX Mapping

Concept	NOX Mode	Example
Create	`build`	Define new component, API, or file structure.
Read / Reflect	`signal`	Write a pulse check or instinct log.
Update	`maintenance`	Refactor folder structure or rename log entries.
Delete / Clean	`maintenance`	Remove deprecated files or simplify logs.
Debug	`diagnose`	Trace API errors or version mismatches.

Logging Rules

All logs must be reconstructible — they should support audits, retrospectives, or documentation reuse.
“Messy” or short entries are fine as long as the pattern is respected.
Every entry must include a mode, domain, and block (even if minimal).
Use real dates — NOX is chronological first, structured second.

Explore NOX

← Back to What is NOX
← Return to Portfolio Home