Specification — wf-05-01¶
US-05-01-02 — Emit a Machine-Readable Assembly Log¶
As an AIOps engineer, I want a machine-readable log during assembly, so that I can trace include structure and outputs.
REQ-00-00-00-03 — Machine-Readable Diagnostics¶
When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.
Coverage: verified.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
REQ-04-01-01-02 — Write JSONL Log during Assembly¶
When arqix assemble build runs, arqix SHALL write a JSONL log during assembly.
Coverage: verified.
REQ-04-01-01-03 — Configure Assembly Log Path¶
The assembly log path SHALL be configurable.
Coverage: uncovered.
REQ-04-01-01-04 — Emit One Record per Assembly Step¶
When an assembly step executes, arqix SHALL emit exactly one stable JSONL record for it.
Coverage: uncovered.
REQ-04-01-01-05 — Carry Required Fields in Log Records¶
Each assembly log record SHALL contain at least doc, chapter_id, out, include, sha256, bytes, and at_line.
Coverage: uncovered.
REQ-05-01-02-01 — Keep Log Records Parseable Downstream¶
The assembly log records SHOULD be parseable by downstream tooling without guessing field names.
Coverage: verified.
US-05-01-04 — Parse Document Structure Deterministically for Automation¶
As an AIOps engineer, I want to use chapter and include directives in Markdown, so that document structure can be interpreted reliably by tooling and downstream automation.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
US-05-01-06 — Search and Read Documentation via CLI¶
As an AIOps engineer, I want to search and read documentation, so that I can quickly retrieve structured content via CLI and later through MCP.
REQ-00-00-00-11 — Fast Documentation Retrieval¶
Search and read commands SHOULD return results within one second on a repository of one thousand documents.
Coverage: verified.
US-05-01-07 — Build Machine-Readable Trace Graphs¶
As an AIOps engineer, I want to scan traceability information, so that documentation, code, and test references can be exposed as a machine-readable graph for downstream tooling.
REQ-00-00-00-03 — Machine-Readable Diagnostics¶
When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.
Coverage: verified.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
US-05-01-08 — Export a Deterministic Document Catalog¶
As an AIOps engineer, I want a deterministic document catalog export, so that downstream indexing and retrieval systems can consume arqix content without scraping Markdown.
REQ-00-00-00-03 — Machine-Readable Diagnostics¶
When arqix emits a diagnostic, arqix SHALL provide it in a documented machine-readable format.
Coverage: verified.
REQ-05-01-08-01 — Emit a JSON Document Catalog¶
When arqix doc list runs, arqix SHALL emit a JSON catalog with stable ordering and core metadata for each document.
Coverage: verified.
REQ-05-01-08-02 — Carry Required Fields in Catalog Entries¶
Each catalog entry SHALL include at least id, kind, title, lang, and the source path.
Coverage: uncovered.
REQ-05-01-08-03 — Filter the Catalog by Kind and Language¶
When arqix doc list is invoked with kind or language filters, arqix SHALL filter the catalog accordingly.
Coverage: verified.
US-05-01-09 — Observe Assembled Outputs for Downstream Tooling¶
As an AIOps engineer, I want to assemble a doc package into pages, so that downstream tools can consume stable, deterministically produced outputs from modular source units.
REQ-00-00-00-06 — Effective Configuration as Baseline¶
The arqix CLI SHALL resolve every command against the effective configuration.
Coverage: verified.
US-05-01-10 — Read Structured Document Sections with Stable Selectors¶
As an AIOps engineer, I want to read specific sections of a document using stable selectors, so that agents can cite the right context without reparsing whole files.
REQ-00-00-00-04 — Deterministic IDs and Slugs¶
The arqix CLI SHALL derive document IDs and slugs deterministically from the configured policy.
Coverage: verified.
REQ-05-01-10-01 — Retrieve Sections by Slug or Anchor¶
When arqix doc read is invoked with a heading slug or explicit anchor, arqix SHALL return the selected section.
Coverage: verified.
REQ-05-01-10-02 — Include Metadata and Selector Details in Reads¶
The structured read output SHALL include the resolved document metadata and selector details.
Coverage: uncovered.
REQ-05-01-10-03 — Distinguish Document from Selector Misses¶
If a read fails, then the diagnostic SHALL identify whether the document or the selector was not found.
Coverage: verified.
US-05-01-12 — Expose Arqix via MCP over STDIO¶
As an AIOps engineer, I want to expose arqix via MCP over stdio, so that agents can use standardized tools to access documentation.
REQ-05-01-12-01 — Serve MCP over Stdio¶
When arqix mcp serve runs, arqix SHALL serve MCP over stdio transport.
Coverage: verified.
REQ-05-01-12-02 — Expose Search, Read, and List Tools¶
The MCP server SHALL expose at least the tools search, read, and list.
Coverage: verified.
US-05-01-15 — Export the Corpus as an OKF Knowledge Bundle¶
As an assessor feeding documentation into agentic tooling, I want the corpus exported as an Open Knowledge Format bundle, so that any OKF-consuming agent or catalog can use it without a translation layer.
REQ-05-01-15-01 — Export an OKF Bundle¶
The arqix CLI SHALL export the corpus as an Open Knowledge Format bundle of artefact-ready Markdown concept documents.
Coverage: verified.
REQ-05-01-15-02 — Map OKF Fields from Declared Metadata¶
When exporting an OKF bundle, arqix SHALL map each concept document's OKF fields from the source document's declared metadata, omitting fields whose source metadata is absent.
Coverage: verified.
REQ-05-01-15-03 — Keep the Knowledge Bundle Scoped and Deterministic¶
When exporting an OKF bundle, arqix SHALL produce a bundle that honours the publish scope and the document lifecycle and is identical for identical inputs.
Coverage: verified.