Documentation Index
Documentation Index
Browse the available NXD reference documentation by section and sub-section. The index below covers the current documentation set under the docs tree.
Coverage: 190 documents indexed across the available documentation sections.
Sections below include compiler notes, backend mappings, runtime semantics, security specifications, language guidance, ecosystem guidance, and appendix examples.
Core Documents 9
Project vision, licensing, contribution guidance and top-level documents.
RO905 Changelog
Technical reference material for the surrounding subsystem.
RO910 CONTRIBUTING
Contribution workflow, governance, and development guidance.
RO001 Error Handling Specification
Error handling and failure-mode documentation.
RO002 LEXICAL SPECIFICATIONS
Lexical grammar and tokenization rules.
RO920 MIT License
Project licensing and distribution terms.
RO003 Memory Management
Technical reference material for the surrounding subsystem.
**NXD Language Changelog**
Technical reference material for the surrounding subsystem.
RO950 README : NXD
Technical reference material for the surrounding subsystem.
RO004 NXD Vision
High-level language vision, project goals, and platform direction.
All Tests 82
Tests Nim Compiler Failed 13
FT010 (tiny test)
Technical reference material for the surrounding subsystem.
FT029 (micro test)
Technical reference material for the surrounding subsystem.
FT103 (micro failure)
Technical reference material for the surrounding subsystem.
FT105 (micro failure)
Technical reference material for the surrounding subsystem.
FT106 (micro failure)
Technical reference material for the surrounding subsystem.
FT112 (micro failure)
Technical reference material for the surrounding subsystem.
FT117 (micro failure)
Technical reference material for the surrounding subsystem.
FT119
Technical reference material for the surrounding subsystem.
FT133 (micro failure)
Technical reference material for the surrounding subsystem.
FT139
Technical reference material for the surrounding subsystem.
FT140
Technical reference material for the surrounding subsystem.
nim_move_basic
Technical reference material for the surrounding subsystem.
FT207
Technical reference material for the surrounding subsystem.
Tests Nim Compiler Passed 69
PT001
Technical reference material for the surrounding subsystem.
PT002
Technical reference material for the surrounding subsystem.
PT003
Technical reference material for the surrounding subsystem.
PT004
Technical reference material for the surrounding subsystem.
PT005 (micro test)
Technical reference material for the surrounding subsystem.
PT006 (micro test)
Technical reference material for the surrounding subsystem.
PT007 LET X SET
Technical reference material for the surrounding subsystem.
PT008
Technical reference material for the surrounding subsystem.
PT009 (micro test)
Technical reference material for the surrounding subsystem.
PT011 IF | ELSE
Technical reference material for the surrounding subsystem.
PT012 (micro test)
Technical reference material for the surrounding subsystem.
FT013 (micro test)
Technical reference material for the surrounding subsystem.
PT014
Technical reference material for the surrounding subsystem.
FT015 (micro test)
Technical reference material for the surrounding subsystem.
PT016 LET | SET | LOOP
Technical reference material for the surrounding subsystem.
PT017 (micro test) STRINGS
Technical reference material for the surrounding subsystem.
FT018 CLONE
Technical reference material for the surrounding subsystem.
PT019
Technical reference material for the surrounding subsystem.
PT020
Technical reference material for the surrounding subsystem.
PT021 (micro test)
Technical reference material for the surrounding subsystem.
FT022 (micro test)
Technical reference material for the surrounding subsystem.
PT023 (micro test)
Technical reference material for the surrounding subsystem.
PT024 MUL DIV
Technical reference material for the surrounding subsystem.
PT025 MOD NEQ EQ
Technical reference material for the surrounding subsystem.
PT026 GT LT
Technical reference material for the surrounding subsystem.
PT027 READY false none
Technical reference material for the surrounding subsystem.
FT028 (micro test)
Technical reference material for the surrounding subsystem.
PT030 LOOP | ADD
Technical reference material for the surrounding subsystem.
PT031 READY | MATCH | WAIT | HOLD
Technical reference material for the surrounding subsystem.
FT032 (micro test)
Technical reference material for the surrounding subsystem.
PT033 (micro test)
Technical reference material for the surrounding subsystem.
PT034 (micro test)
Technical reference material for the surrounding subsystem.
PT035
Technical reference material for the surrounding subsystem.
PT036
Technical reference material for the surrounding subsystem.
PT037 CLONE | BORROW | MOVE
Technical reference material for the surrounding subsystem.
PT038
Technical reference material for the surrounding subsystem.
PT039
Technical reference material for the surrounding subsystem.
PT040
Technical reference material for the surrounding subsystem.
PT101 Intentional failures
Technical reference material for the surrounding subsystem.
PT102 Intentional Failures
Technical reference material for the surrounding subsystem.
PT104 Intentional Failures
Technical reference material for the surrounding subsystem.
PT107 Intentional Failure
Technical reference material for the surrounding subsystem.
FT108 Intentional Failure
Technical reference material for the surrounding subsystem.
FT109 Intentional Failure
Technical reference material for the surrounding subsystem.
PT111 Intentional Failure
Technical reference material for the surrounding subsystem.
PT114
Technical reference material for the surrounding subsystem.
PT116 Intentiopnal Failure
Technical reference material for the surrounding subsystem.
PT118
Technical reference material for the surrounding subsystem.
PT120
Technical reference material for the surrounding subsystem.
PT121 Intentional Failure
Technical reference material for the surrounding subsystem.
PT123 Intentional Failure
Technical reference material for the surrounding subsystem.
PT124 Intentional Failure
Technical reference material for the surrounding subsystem.
PT125 Intentional Failure
Technical reference material for the surrounding subsystem.
PT127 Intentional Failure
Technical reference material for the surrounding subsystem.
PT130 Intentional Failure
Technical reference material for the surrounding subsystem.
PT131 Intentional Failure
Technical reference material for the surrounding subsystem.
PT134 Intentional Failure
Technical reference material for the surrounding subsystem.
PT135
Technical reference material for the surrounding subsystem.
PT136
Technical reference material for the surrounding subsystem.
PT137 Intentional Failure
Technical reference material for the surrounding subsystem.
PT138
Technical reference material for the surrounding subsystem.
PT201
Technical reference material for the surrounding subsystem.
PT203
Technical reference material for the surrounding subsystem.
nim_scope_lifetime
Technical reference material for the surrounding subsystem.
nim_comptime_constant
Technical reference material for the surrounding subsystem.
nim_move_basic
Technical reference material for the surrounding subsystem.
PT208
Technical reference material for the surrounding subsystem.
nim_scope_lifetime
Technical reference material for the surrounding subsystem.
PT210 (specialty test)
Technical reference material for the surrounding subsystem.
Appendix 1
Reference appendices, cookbooks, and examples.
Backend 4
Backend mapping and target-specific code generation notes.
Compiler 3
Compiler frontend, IR, lowering, and architecture guidance.
Ecosystem 3
Package management, standard library, and build system notes.
Golden Examples 40
Reference examples organized by size and complexity.
Large Examples 10
Larger examples that exercise more of the language.
LE001: DISTRIBUTED TASK QUEUE (PROCESS + CHANNELS + TASKS + RESULT + OPTION)
Technical reference material for the surrounding subsystem.
LE002: AUTHENTICATION SERVICE (MODULES + TRAITS + GENERICS + SECURITY)
Technical reference material for the surrounding subsystem.
LE003: KEY-VALUE DATABASE (MAPS + PERSISTANCE SIMULATION + RESULT + OPTION)
Technical reference material for the surrounding subsystem.
LE004: EVENT BUS (PUB/SUB + CHANNELS + PROCESSES + MULTI-MODULE)
Technical reference material for the surrounding subsystem.
LE005: COMPILER LINTER PLUGIN (AST HOOKS + DIAGNOSTICS + MULTI-RULE)
Technical reference material for the surrounding subsystem.
LE006: MESSAGING MICROSERVICE (AUTH + CHANNELS + PROCESSES + RESULT)
Technical reference material for the surrounding subsystem.
LE007: CONFIGURATION LOADER (MODULES + INIT + RESULT + OPTION + PARSING)
Technical reference material for the surrounding subsystem.
LE008: JOB SCHEDULER (TASKS + CHANNELS + TIMERS + RESULT)
Technical reference material for the surrounding subsystem.
LE009: MULTI-MODULE E-COMMERCE CART (STRUCTS + MAPS + RESULT + TRAITS)
Technical reference material for the surrounding subsystem.
LE010: MONITORING SYSTEM (PROCESSES + CHANNELS + ALERTS + MULTI-MODULE)
Technical reference material for the surrounding subsystem.
Medium Examples 10
Mid-sized examples that demonstrate common constructs.
ME001: USER SERVICE (CRUD + RESULT + OPTION)
Technical reference material for the surrounding subsystem.
ME002: CONCURRANCY PIPELINE (PRODUCER -> WORKER -> SINK)
Technical reference material for the surrounding subsystem.
ME003: OWNERSHIP WITH COLLECTIONS (MOVE, BORROW, CLONE ON LIST)
Technical reference material for the surrounding subsystem.
ME004: SECURE LOGGING WITH CAPABILITIES + CHANNELS
Technical reference material for the surrounding subsystem.
ME005: RESULT + OPTION COMPOSITION (SAFE LOOKUP + PARSE)
Technical reference material for the surrounding subsystem.
ME006: GENERICS + TRAITS: SORTABLE LIST
Technical reference material for the surrounding subsystem.
ME007: RUNTIME + INIT + CYCLIC-SAFE IMPORTS
Technical reference material for the surrounding subsystem.
ME008: CHANNELS + TASKS: FAN-OUT / FAN-IN
Technical reference material for the surrounding subsystem.
ME009: COMPILER PLUGIN: ENFORCE EXPLICIT AS ON NUMERIC OPS
Technical reference material for the surrounding subsystem.
ME010: MULTI-MODULE SERVICE: AUTH + USER + APP
Technical reference material for the surrounding subsystem.
Tiny Examples 10
Compact examples that highlight small language patterns.
TE001 — CRUD (Create/Read/Update/Delete)
Technical reference material for the surrounding subsystem.
TE002 — Concurrency (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE003 — Channels (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE004 — Ownership (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE005 — Security (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE006 — Error Handling (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE007 — Generics (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE008 — Runtime (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE009 — Compiler Plugin (Tiny Layer)
Technical reference material for the surrounding subsystem.
TE0010 — Multi‑Module (Tiny Layer)
Technical reference material for the surrounding subsystem.
XLarge Examples 10
Very large examples for architecture and scale testing.
XE001: DISTRIBUTED JOB ORCHESTRATION (MULTI-SERVICE, MULTI-MODULE, SUPERVISION)
Technical reference material for the surrounding subsystem.
XE002: DISTRIBUTED CONFIGURATION SERVICE (MULTI-MODULE, VERSIONING, WATCHERS, CHANNELS, TASKS, RESULT, OPTION)
Technical reference material for the surrounding subsystem.
XE003: Distributed Logging Mesh (Routers, Filters, Sinks, Channels, Supervision, Multi‑Module)
Technical reference material for the surrounding subsystem.
XE004: Distributed Security Event Correlator (events, rules, correlation windows, channels, tasks, multi‑module, supervision)
Technical reference material for the surrounding subsystem.
XE005: Distributed Metrics Aggregator (collectors, reducers, rollups, channels, tasks, multi‑module, supervision)
Technical reference material for the surrounding subsystem.
XE006: Distributed Notification Hub
Technical reference material for the surrounding subsystem.
XE007: Distributed Storage Replicator
Technical reference material for the surrounding subsystem.
XE008: Distributed Access Control Engine
Technical reference material for the surrounding subsystem.
XE009: Distributed Threat Intelligence Pipeline
Technical reference material for the surrounding subsystem.
XE010: Security Orchestration & Automated Response (SOAR) (playbooks, triggers, actions, automation, channels, multi‑module, supervision)
Technical reference material for the surrounding subsystem.
Language Guide 5
Language syntax, typing, grammar, and semantics.
LG001 Equality & Mutation Semantics Specification
Equality and mutation semantics.
LG002 Generic Constraints Specification
Generic constraints and instantiation rules.
LG003 Grammar Blueprint
Technical reference material for the surrounding subsystem.
LG004 Type Conversion & Casting Semantics
Typing, casting, and type-system rules.
LG005 type system specification
Typing, casting, and type-system rules.
Referance Architecture 21
Referance architecture snapshots and design notes.
**RA001: Security Platform**
Referance architecture snapshot used for design comparison.
**RA002: Orchestration Platform** (distributed job runner • workers • scheduler • config • metrics • logging)
Referance architecture snapshot used for design comparison.
**RA003: Network Security Stack** (firewall • routing • VPN • sessions • monitoring)
Referance architecture snapshot used for design comparison.
**RA004: Compiler Stack** (NXD front‑end • IR • optimizer • backend mapper)
Referance architecture snapshot used for design comparison.
**RA005: Distributed Logging & Telemetry Platform** (log ingestion • log routing • log storage • dashboards • alerts)
Referance architecture snapshot used for design comparison.
**RA006: Distributed Configuration & Secrets Platform** (config registry • dynamic reload • secret vault • versioning)
Referance architecture snapshot used for design comparison.
**RA007: Distributed Event Streaming Platform**
Referance architecture snapshot used for design comparison.
**RA008: Distributed Task Queue & Workflow Engine** (workflows • DAGs • retries • backoff • state machine)
Referance architecture snapshot used for design comparison.
**RA009: Distributed Key‑Value Store (Clustered)** (replication • sharding • consistency • leader election)
Referance architecture snapshot used for design comparison.
**RA010: Distributed Filesystem (Object Store + Block Store)** (objects • blocks • replication • metadata • directory tree)
Referance architecture snapshot used for design comparison.
**RA011: Distributed Container Runtime**
Referance architecture snapshot used for design comparison.
**RA012 Distributed Service Mesh** (sidecars • mTLS • routing • retries • circuit breakers)
Referance architecture snapshot used for design comparison.
*RAO13: Distributed Identity & Access Federation** (OAuth2 • JWT • SSO • trust domains • identity graph)
Referance architecture snapshot used for design comparison.
**RA014: Distributed Monitoring & Observability Stack** (metrics • traces • spans • dashboards • alerts)
Referance architecture snapshot used for design comparison.
**RA015: Distributed Scheduler & Cron Platform** (cron • intervals • calendars • distributed timers)
Referance architecture snapshot used for design comparison.
**RA016: Distributed Notification & Messaging Platform** (email • SMS • push • webhooks • routing)
Referance architecture snapshot used for design comparison.
**RA017: Distributed Secrets Rotation & Key Management Platform** (KMS • rotation • wrapping • unwrapping • audit)
Referance architecture snapshot used for design comparison.
**RA018: Distributed API Gateway & Edge Router**
Referance architecture snapshot used for design comparison.
**RA019: Distributed Feature Flag & Rollout Platform** (percent rollout • canary • A/B testing • targeting)
Referance architecture snapshot used for design comparison.
**RA020: Distributed Configuration Snapshot & Time‑Travel Platform** (version snapshots • diffs • rollback • time‑travel queries)
Referance architecture snapshot used for design comparison.
**RA021: Distributed Search & Indexing Engine** (full‑text search • inverted index • ranking • shards)
Referance architecture snapshot used for design comparison.
Runtime 5
Runtime semantics, execution flow, and concurrency model.
RT001 Channel Semantics Specification
Channel semantics and communication behavior.
RT002 CONCURRANCY_MODEL.md
Concurrency and scheduling semantics.
RT003 execution model
Runtime execution flow and semantics.
RT004 Operational Semantics
Technical reference material for the surrounding subsystem.
RT005 runtime architecture
Runtime architecture and execution model details.
Security 10
Security invariants, propagation, and safety claims.
SE001 AGENT MODIFICATION SAFTEY CLAIM
Technical reference material for the surrounding subsystem.
SE002 Channel Safety Claim
Technical reference material for the surrounding subsystem.
SE003 Concurrency Safety Claim
Technical reference material for the surrounding subsystem.
SE004 ERROR HANDLING CLAIM
Error handling and failure-mode documentation.
SE005 ERROR INVARIATS
Safety invariant descriptions and validation notes.
SE006 INVARIANT MODEL
Safety invariant descriptions and validation notes.
SE007 MODULE ISOLATION CLAIM
Technical reference material for the surrounding subsystem.
SE008 PROPOGATION-REVOCATION.md
Technical reference material for the surrounding subsystem.
SE009 SECURITY_SPEC.md
Security invariants and safety guarantees.
SE010 Type Safety Claim
Typing, casting, and type-system rules.
Semantic Conformance 7
semantic rules, invariants, and backend equivalence requirements
SC001 Backend Equivalence Classification
Technical reference material for the surrounding subsystem.
SC002 Capability Security Semantics
Security invariants and safety guarantees.
SC003 Concurrency and Mailbox Semantics
Technical reference material for the surrounding subsystem.
SC004 Core Semantic Equivalence
Technical reference material for the surrounding subsystem.
SC005 Move Borrow Clone Semantics
Technical reference material for the surrounding subsystem.
SC006 none and Option Semantics
Technical reference material for the surrounding subsystem.