Writing & Formatting Style (Short)

This short guide captures the most important rules to keep the docs consistent and machine-friendly.

• Frontmatter: Every MDX must include title, description (one sentence), date, tags and section where applicable.
• Component names: Use lowercase for common components in body text (node, central, frontend). Use Title Case in headings.
• Timestamps: Use explicit fields: timestamp_node_us (node GNSS time, microseconds), timestamp_central_us (central ingest time, microseconds). Always use UTC.
• Units & numbers: Use SI units with a space: 40 MHz, 1.5 s. For sample rates prefer 40 MSPS or 40e6 samples/s and show calculations for bandwidth/bytes.
• Acronyms: Define on first use, e.g., "OPM (Operation Manager)". Add short glossary entries for domain terms.
• Oxford comma: Use the Oxford comma in lists.
• Code blocks: Use fenced code blocks with language tags (json, bash, text). Do not include inline comments in JSON examples.
• ADR metadata: ADR frontmatter must include status, owner, date, decision_target or Target Decision Date.
• Voice: Prefer active voice for procedures and steps.
• Schema references: Link to machine-readable schemas (JSON Schema / Protobuf) where available.

Follow this short guide for edits; we will expand it into a longer guide as needed.