NOX Logging 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] - Title [DOMAIN] ${block-descriptor: |  
  - content entry
}

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.
dual-axis shells: Every entry must include a mode and a domain.
Use real dates — NOX is chronological first, structured second.

Why This Format Matters

NOX isn't just about syntax. It's about survival. These entries are designed to:

🧩 Serve as a single source of truth across logs, wikis, and commits
⏱ Let you reconstruct what happened — even months later
🔗 Emit to other files — enabling modular documentation
🧠 Help you track work, emotion, and signal without cluttering the codebase

Real Example

from: nox/models/homework/2025/07-july/07-11-homework/models/hnet-upgrade/hnet-log-07-11.md


           
    ## Checks 
    
    2025-07-11 [mode:refactor] - [x] Update Wallplate Routing [HNET-19] ${log: |
        
        - refactor(wallplates): add wallplate-list for default view, route /:bldg for detail 

        - **emit_to**: [notes: hnet wallplates](hnet-wallplates-notes-07-11.md)  
        
        - **commit**: refactor(wallplates): add wallplate-list for default view, route /:bldg for detail  
          - Added WallplateListComponent for default /wallplates view (all buildings)
          - Updated WallplatesComponent to handle /wallplates/:bldg route
          - Refactored API to allow full wallplate list when no bldgcode is provided
          - Improved route clarity and UI structure for building-specific detail views

    }

Minimal Example


2025-07-13 [mode:signal] - Woke up exhausted. [PULSE]

← Back to What is NOX
← Return to Portfolio Home