code wiki / doc
topic: doc
78 modules sharing the doc name family (derived from the tree's prefix discipline).
The 'doc' topic family in the Nishi sovereign ecosystem manages secure, content-addressed document handling and confidentiality. It uses _doc_cas_authored to generate immutable document IDs via sha256, ensuring data integrity. nx_doc_annotate provides a LEGAL RUNG D4 markup overlay for annotations, while nx_doc_at_rest securely stores confidential documents with cryptographic sealing. These modules work together to enable a trusted, auditable, and confidential document lifecycle within the ecosystem.
auto-narrated by the local model from this topic's module headers; links verified against the wiki index.
narrated overview -- maintained by the narration lane, module links verified against this wiki.
| module | description | lines | funcs |
|---|---|---|---|
| _doc_cas_authored.nx | content-addressed document ID via sha256, bits-up | 14 | 2 |
| nx_doc_annotate.nx | LEGAL RUNG D4: the sovereign annotation / markup overlay. | 219 | 13 |
| nx_doc_annotate_gate.nx | GATE for LEGAL D4 (nx_doc_annotate). | 235 | 5 |
| nx_doc_at_rest.nx | AT-REST WIRING: the thin store layer that seals CONFIDENTIAL docs with the crypto core | 109 | 6 |
| nx_doc_at_rest_gate.nx | MEASURED hermetic gate for the at-rest wiring (nx_doc_at_rest). Fresh nonce domain per | 139 | 10 |
| nx_doc_authz.nx | PER-CLIENT EYES-ONLY authorization for confidential docs (the P2 vault read gate). Closes the | 80 | 8 |
| nx_doc_authz_gate.nx | MEASURED hermetic gate for per-client EYES-ONLY authz + the private-doc read route | 130 | 9 |
| nx_doc_autoheal.nx | the Doctor's autonomous RESOLVE loop. Closes the two halves the team already has | 63 | 4 |
| nx_doc_autoheal_apply.nx | 81 | 4 | |
| nx_doc_autoheal_gate.nx | 64 | 5 | |
| nx_doc_build_resolve.nx | Automatically builds, diagnoses, and heals modules with real-time error resolution and rebuild verification. | 123 | 7 |
| nx_doc_catalog.nx | R2 of THE NISHI DOCUMENT-INTELLIGENCE arc: the LIBRARIAN -- CATALOG / ORGANIZE / | 47 | 2 |
| nx_doc_catalog_gate.nx | R2 GATE for the doc-intelligence LIBRARIAN: proves documents are cataloged as | 83 | 4 |
| nx_doc_census.nx | D1 stone of NISHI_DOCS_DOCTRINE_ROADMAP V2. | 607 | 26 |
| nx_doc_census_real_audit_test.nx | SUBSTRATE-WIDE V2 audit binary. | 68 | 1 |
| nx_doc_census_real_listing_test.nx | substrate-wide V2 audit | 33 | 1 |
| nx_doc_census_run_test.nx | end-to-end bits-up docs audit binary. | 76 | 1 |
| nx_doc_census_test.nx | KAT for D1 docs census classifier. | 202 | 1 |
| nx_doc_classify.nx | R3 of THE NISHI DOCUMENT-INTELLIGENCE arc: CLASSIFY a document by TYPE (medical | 58 | 3 |
| nx_doc_classify_gate.nx | R3 GATE: proves the data-driven document classifier routes documents to the | 95 | 6 |
| nx_doc_constscan.nx | static detector for the LM-030 footgun (sibling of nx_doc_ubscan/LM-031): indexing a | 122 | 5 |
| nx_doc_constscan_gate.nx | 47 | 5 | |
| nx_doc_constscan_run.nx | 29 | 2 | |
| nx_doc_crypto.nx | ENCRYPTION-AT-REST core for CONFIDENTIAL docportal shards (client -prv-/-secret-/uploads; | 179 | 11 |
| nx_doc_crypto_gate.nx | MEASURED hermetic gate for encryption-at-rest (nx_doc_crypto). Fresh nonce domain per | 107 | 9 |
| nx_doc_dashboard.nx | D23 dashboard composite. | 279 | 6 |
| nx_doc_dashboard_substrate_state_test.nx | writes substrate's | 91 | 1 |
| nx_doc_dashboard_test.nx | KAT + visual smoke for D23. | 57 | 1 |
| nx_doc_decision.nx | D20 first stone of V5 docs doctrine. | 198 | 6 |
| nx_doc_decision_test.nx | KAT for D20 ADR-shape primitive. | 84 | 1 |
| nx_doc_demo_healed.nx | a DELIBERATELY broken subject for dogfooding the Doctor's autonomous heal on the REAL | 12 | 1 |
| nx_doc_demo_kw.nx | the SECOND empty-.s sub-case for dogfooding: a reserved keyword (`match`) used as a | 12 | 2 |
| nx_doc_demo_subject.nx | a DELIBERATELY broken subject for dogfooding the Doctor's autonomous heal on the REAL | 12 | 1 |
| nx_doc_demo_subject_healed.nx | a DELIBERATELY broken subject for dogfooding the Doctor's autonomous heal on the REAL | 12 | 1 |
| nx_doc_envelope.nx | LEGAL RUNG D2: the e-signature ENVELOPE workflow. | 355 | 19 |
| nx_doc_envelope_gate.nx | GATE for LEGAL D2 (nx_doc_envelope). | 266 | 5 |
| nx_doc_extract.nx | R1 of THE NISHI DOCUMENT-INTELLIGENCE arc: READ a document's text into STRUCTURED | 155 | 7 |
| nx_doc_extract_gate.nx | R1 GATE for THE NISHI DOCUMENT-INTELLIGENCE arc. Proves reading an itemized | 81 | 5 |
| nx_doc_extractor_md.nx | V2.0 P-7: deep .md artifact parser. | 153 | 3 |
| nx_doc_extractor_nx.nx | V2.0 P-6: deep .nx artifact parser. | 255 | 5 |
| nx_doc_func_scan.nx | bits-up function-pattern extraction. | 174 | 1 |
| nx_doc_func_scan_test.nx | KAT for bits-up func-pattern scanner. | 95 | 1 |
| nx_doc_heal_let.nx | DOCTOR auto-fixer (doc_heal family) for the #1 empty-.s cause: a `let` binding that is | 87 | 4 |
| nx_doc_heal_let_gate.nx | 56 | 5 | |
| nx_doc_incumbent.nx | D21 provenance tier + D22 multi-incumbent | 263 | 11 |
| nx_doc_incumbent_test.nx | KAT for D21+D22 primitives. | 108 | 1 |
| nx_doc_inref.nx | incoming-reference counter for substrate docs. | 93 | 3 |
| nx_doc_inref_test.nx | KAT for doc-reference counter. | 70 | 1 |
| nx_doc_kwscan.nx | DOCTOR reserved-keyword diagnosis (the reserved-kw sub-case of empty-.s, the sibling of the | 125 | 7 |
| nx_doc_kwscan_gate.nx | 58 | 4 | |
| nx_doc_layout.nx | document layout: text -> 8-bit GRAYSCALE page bitmap (front half of "print real | 101 | 3 |
| nx_doc_layout_test.nx | gate for the grayscale document layout engine. Unique exit codes per invariant: | 91 | 3 |
| nx_doc_lexstat.nx | MEASUREMENT PROBE for the keyword-stuffing penalty design (2026-08-04, debt | 74 | 4 |
| nx_doc_mainscan.nx | DOCTOR diagnosis for a NEW failure class discovered live this session: nxasm exits rc=102 | 59 | 3 |
| nx_doc_mainscan_gate.nx | 48 | 3 | |
| nx_doc_member.nx | THE NISHI LIBRARIAN joins the team: registers the `docintel` DOMAIN into THE NISHI | 36 | 4 |
| nx_doc_print.nx | PRINT A REAL DOCUMENT, end to end, 100% sovereign: text -> grayscale page (nx_doc_layout | 146 | 5 |
| nx_doc_render_mermaid.nx | D10 first stone of V4 docs doctrine. | 135 | 7 |
| nx_doc_render_mermaid_test.nx | KAT for D10 Mermaid emitter. | 64 | 1 |
| nx_doc_research_fetch.nx | the Nishi RESEARCHER's sovereign web-fetch for THE NISHI DOCUMENT-INTELLIGENCE | 108 | 5 |
| nx_doc_scan.nx | R4 of THE NISHI DOCUMENT-INTELLIGENCE arc: the SCAN / CAPTURE leg (paper/image -> | 139 | 7 |
| nx_doc_scan_gate.nx | R4 GATE for the doc-intelligence SCAN/CAPTURE leg: proves sovereign template-match | 94 | 7 |
| nx_doc_seal.nx | LEGAL RUNG D5: tamper-evident e-signature SEAL. | 129 | 4 |
| nx_doc_seal_gate.nx | GATE for LEGAL D5 (nx_doc_seal). | 141 | 4 |
| nx_doc_serve.nx | LEGAL RUNG D3: open-the-document-in-the-app-of-choice. | 147 | 8 |
| nx_doc_serve_gate.nx | GATE for LEGAL D3 (nx_doc_serve). | 137 | 4 |
| nx_doc_to_urf.nx | render a whole text document across as many pages as needed into ONE multi-page URF. | 49 | 1 |
| nx_doc_to_urf_test.nx | gate for the multi-page document->URF encoder. Unique exit codes per invariant: | 54 | 3 |
| nx_doc_ubscan.nx | a static detector for the UNDEFINED-BEHAVIOR pattern LM-031: an inline cast-then-index | 45 | 3 |
| nx_doc_ubscan_gate.nx | 43 | 4 | |
| nx_doc_vault.nx | LEGAL RUNG D1: per-tenant document vault (retention core). | 177 | 8 |
| nx_doc_vault_gate.nx | GATE for LEGAL D1 (nx_doc_vault). | 130 | 3 |
| nx_doc_view.nx | the Nishi browser's DOCUMENT-VIEWER DISPATCH. Makes the browser an omnitool WITHOUT bloat: | 119 | 9 |
| nx_doc_view_gate.nx | gate for the document-viewer DISPATCH (the browser omnitool core). Proves nx_doc_view | 116 | 11 |
| nx_doc_xref.nx | cross-reference verification primitives. | 555 | 10 |
| nx_doc_xref_dual_audit_test.nx | substrate-wide multi-namespace | 35 | 1 |
| nx_doc_xref_real_audit_test.nx | substrate-wide broken-ref audit. | 29 | 1 |
| nx_doc_xref_test.nx | KAT for cross-reference verification. | 125 | 1 |