Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions GLOSSARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ update both its glossary definition and its multilingual correspondence here.
| Evidence | 证据 |
| Claim | 检查主张 |
| Budget | 预算 |
| ConceptDoc | 概念文档 |
| ConceptRegistry | 概念注册表 |
| Concept ref | 概念引用 |
| Realization shape | 实现形态 |
| Effect surface | 效应表面 |
| Effect | 效应 |
Expand All @@ -33,8 +36,10 @@ update both its glossary definition and its multilingual correspondence here.
| Content-addressed | 内容寻址 |
| Content identity | 内容身份 |
| Provenance hash | 来源哈希 |
| Explain protocol | 解释协议 |
| Diagnostic | 诊断 |
| HoleReport | 洞报告 |
| Repair hint | 修复提示 |
| Dependency | 依赖 |
| Checker | 检查器 |

Expand All @@ -60,6 +65,12 @@ update both its glossary definition and its multilingual correspondence here.

**Content-addressed package** (SEP-0008): Package identified by hashes of normalized signatures, intents, properties, realizations, evidence, and dependency inputs.

**ConceptDoc** (SEP-0010): Machine-readable record that explains one Spore concept for `spore explain`, diagnostics, LSP, and Agent tooling.

**Concept ref** (SEP-0010): Stable concept id attached to a diagnostic, HoleReport projection, or explain response.

**ConceptRegistry** (SEP-0010): Ordered collection of `ConceptDoc` records plus schema identity.

## D

**Declared effects** (SEP-0003): Effect names explicitly written on a function or platform surface.
Expand Down Expand Up @@ -90,6 +101,8 @@ update both its glossary definition and its multilingual correspondence here.

**Evidence hash** (SEP-0008): Hash of the evidence records selected by a package or publication policy.

**Explain protocol** (SEP-0010): CLI and JSON contract for resolving diagnostic codes, language concepts, and surface symbols into compiler-owned concept docs.

**`@export`** (SEP-0001, SEP-0008): Attribute marking a public Spore function as an outbound ABI surface, for example `@export("C")`.

## F
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ in dependency order:
questions used in review.
2. [SEP-0001](seps/SEP-0001-core-syntax.md) for draft root syntax forms.
3. [SEP-0002](seps/SEP-0002-type-system.md) through [SEP-0004](seps/SEP-0004-cost-analysis.md) for core static semantics.
4. [SEP-0005](seps/SEP-0005-hole-system.md) and [SEP-0006](seps/SEP-0006-compiler-architecture.md) for hole and compiler surfaces.
4. [SEP-0005](seps/SEP-0005-hole-system.md), [SEP-0006](seps/SEP-0006-compiler-architecture.md), and [SEP-0010](seps/SEP-0010-compiler-as-documentation.md) for hole, compiler, diagnostic, and explain surfaces.
5. [SEP-0007](seps/SEP-0007-concurrency-model.md) through [SEP-0009](seps/SEP-0009-standard-library.md) for larger system layers.

Use [GLOSSARY.md](GLOSSARY.md) when checking cross-SEP terminology.
Expand Down
19 changes: 19 additions & 0 deletions seps-index.json
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,25 @@
"pr": null,
"superseded_by": null
},
{
"path": "seps/SEP-0010-compiler-as-documentation.md",
"sep": 10,
"title": "SEP-0010: Compiler-as-Documentation & Explain Protocol",
"status": "Draft",
"type": "Standards Track",
"authors": [
"Zhan Rongrui"
],
"created": "2026-05-26",
"requires": [
1,
5,
6
],
"discussion": "https://github.com/spore-lang/spore-evolution/discussions/46",
"pr": null,
"superseded_by": null
},
{
"path": "drafts/script-mode.md",
"sep": null,
Expand Down
4 changes: 4 additions & 0 deletions seps/SEP-0005-hole-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ Batch output:

Single-hole queries return the same per-hole object directly.

Human-facing educational renderings of these records are owned by SEP-0010.
Those renderings must stay projections over the same HoleReport data rather than
forming a separate hole protocol.

## Diagnostics impact

Hole diagnostics use `H0xxx` codes:
Expand Down
5 changes: 5 additions & 0 deletions seps/SEP-0006-compiler-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ VerificationBundle
```

Default text, JSON, LSP, and watch outputs are renderings over these records.
SEP-0010 owns the concept registry and explain protocol layered over these same
records.

## Diagnostics impact

Expand All @@ -224,6 +226,9 @@ Diagnostic categories are:
Property diagnostics include failed property checks, counter-witnesses, and
properties that reached an open hole.

Diagnostic teaching metadata, concept references, and `spore explain` behavior
are owned by SEP-0010.

## Drawbacks

Evidence records add storage and schema complexity. The benefit is a durable,
Expand Down
Loading
Loading