Documentation map

Understand the workflow before extending it.

This page summarizes the source documentation and points to the major engineering artifacts in the FerrisOxide repository.

The core workflow.

FerrisOxide Signal currently implements a desktop analysis path from local CSV waveform data to reviewable evidence. The workflow loads channels, models waveforms, applies optional derived transforms, extracts measurements, evaluates pass/fail criteria, and emits reports and visual artifacts.

The embedded-facing pieces are boundaries and shared semantics, not a claim that the desktop CLI is an RTOS application. Their purpose is to reduce the chance that desktop and future runtime rule behavior drift apart.

data-flow.txt source-backed

CSV waveform data
  -> channel mapping
  -> waveform model and metadata
  -> optional derived transforms
  -> reusable measurements
  -> pass/fail criteria
  -> text, JSON, SVG, and rule-package evidence

Read by topic.

These are the documentation areas that matter first for users and future contributors.

Product guide What FerrisOxide does, current status, quick start, and repository map. Open Architecture Crate boundaries, workflow responsibilities, and evidence model. Open Criteria DSL Measurement-backed rule expressions for pass/fail criteria. Open Measurements Reusable extrema, transitions, pulse width, stable-state, transient, and rise/fall measurements. Open Portable rule packages Rule schema, package artifacts, manifests, checksums, and validation report roles. Open Desktop simulation workflow Fixture-driven software simulation workflow over control and verification configs. Open

Examples worth starting with.

These source-backed examples show how FerrisOxide thinks about signals, rules, and evidence.

Heated actuator suite

Passing and failing CSVs, expected JSON reports, production control config, test verification config, CLI smokes, and package export coverage.

Rule package examples

Parse-tested TOML and JSON rules, manifest expectations, checksum output, and validation-report artifacts.

Known-answer validation

Waveforms and expected measurements for checking tolerance, timing, and measurement behavior.

Cloudflare Pages fit.

This website is currently plain static HTML, CSS, and JavaScript. That makes it compatible with Cloudflare Pages without a package install or build step.

Recommended initial Pages settings: connect the kota-wilson/ferrisoxide-site repository, use the main branch, leave the build command blank, and use / as the output directory.

No Cloudflare config, DNS record, CI workflow, dependency lockfile, or deployment token has been committed yet.