Skip to content

Latest commit

 

History

History
130 lines (102 loc) · 6.64 KB

index.md

File metadata and controls

130 lines (102 loc) · 6.64 KB

SEMAPRAX specification library

Status: agent-facing contract index for the versioned specification library. Audience: coding agents, tool authors, and integrators needing exact contracts.

Learning or using Semaprax? Start with the user-facing Semaprax Handbook instead: task-oriented, best-practice documentation with copy-paste examples. This directory is the authoritative specification library behind it — precise, versioned contracts (syntax, wire formats, ABIs, protocols, evidence boundaries) that agents and tools cite for exact behavior.

The v0.4.0 baseline is the last release with a HOSTED GREEN implementation claim. The workspace is at version 0.9.0, installable from source; v0.9.0 publishes five native archives and both per-user installers. Read the completion matrix before treating a versioned contract as a supported feature: a specification is not proof of implementation. Contributors start with First contribution.

Choose a path

You want to… Start here
Install and run your first program Handbook: Install → First program
Learn the language Handbook: Essentials → RFC 0001
Find a command or example Handbook: Cheatsheet · Examples
Fix a diagnostic Handbook: Debugging, or run semaprax help diagnostic <SPX-code>
Find a library API Handbook: Stdlib → Standard-library catalog
Build a multi-file project Handbook: First project → Project Manifest v1
Write .spx as an agent Handbook: Agents → Agent quick reference
Query or change program meaning Agent Context v2 → Semantic Patch v2
Contribute to the compiler First contribution → Development guide
Check feature or release status Completion matrix · Release status

Core concepts

Source and identity

Keep readable .spx files in Git. Public declarations can have stable @id values, so tools can recognize them across edits. Expression IDs may change with each revision. The formatter gives equivalent source one canonical form.

Checked semantic representation

The compiler checks source before it produces HIR (its checked intermediate form) and a versioned semantic graph. Agents can ask that graph focused questions instead of reading an entire project.

Evidence and authority

Reports and evidence describe what was checked; they do not grant permission to write. A change must still authenticate its inputs, replay its evidence, and use an authorized transaction.

Shared backend meaning

Native and WebAssembly backends use the same checked HIR and cleanup plan. Evidence applies only to the targets and program shapes named by each feature's specification.

Public language and workflow references

Agent workflow references

Agent tools follow this sequence:

graph/context → patch → impact/review → evidence replay → atomic apply

Validation checks a proposed change; it does not apply it.

Reference catalog

Versioned reference documents are intentionally precise. They define one wire format, report, ABI, admission profile, or evidence boundary. They are useful to tool and host authors but are not the recommended introduction to SEMAPRAX.

The exhaustive, audience-separated list is in the reference catalog:

  • public language and workflow references;
  • agent and workspace protocol references;
  • target, ABI, schema, and package projections;
  • internal architecture, quality, status, roadmap, decisions, and private experiment contracts.

Compatibility and status

  • v0.4.0 baseline owns the current hosted-green release evidence classification and its relationship to historical evidence.
  • Protocol migrations records compatibility changes between versioned agent-facing formats.
  • Completion matrix owns product status and completion criteria.
  • Changelog owns historical implementation changes.
  • Changelog summary gives a compact latest-notes view.
  • Roadmap owns future sequencing, not implementation claims.

Keeping these responsibilities separate prevents the same status narrative from drifting across the README, RFCs, architecture, and roadmap.