Merge commit '8a86f2ab6d'
This commit is contained in:
commit
2d91943fab
29 changed files with 2712 additions and 21 deletions
27
shared/examples/nav-golden-escape/README.md
Normal file
27
shared/examples/nav-golden-escape/README.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# nav-golden-escape — negative navigation golden (the gate must be able to go red)
|
||||
|
||||
Per catalog's requirement that step 0's gate must be able to **fail** (a gate that can
|
||||
only pass proves nothing), this negative case makes a conformant navigator and a naive one
|
||||
**provably diverge**. It is the counterpart to `nav-golden-hierarchy` (the positive case).
|
||||
|
||||
`bundle/index.md` links one valid sibling and three escaping / trap targets:
|
||||
|
||||
| Link | Class | Conformant outcome |
|
||||
|---|---|---|
|
||||
| `valid.md` | in-bundle | returned |
|
||||
| `../SHOULD-NOT-BE-READ.md` | `..` escape (the decoy really exists, one level up) | skipped; decoy never read |
|
||||
| `../../../../etc/passwd` | deep `..` escape | skipped |
|
||||
| `/etc/passwd` | root-relative **trap** | skipped |
|
||||
|
||||
The trap is the load-bearing one. Under the ratified rule, a leading `/` denotes the
|
||||
**bundle root**, so `/etc/passwd` resolves to `{bundle}/etc/passwd` (no such file → skip),
|
||||
NOT the filesystem path. A naive implementation that reads `/` as filesystem-absolute opens
|
||||
the real `/etc/passwd` — a path-traversal breach. This case fails for any implementation
|
||||
that raises, reads the decoy, or leaks `/etc/passwd` content; it passes only when the
|
||||
read-context is exactly `valid.md`.
|
||||
|
||||
The malformed-target sub-class (an embedded null byte, other invalid path components) is
|
||||
covered by the method-spec §11 **Navigation boundary** seam as a unit test — a literal null
|
||||
byte does not belong in a committed text fixture. (See the relocated finding
|
||||
`docs/plan/2026-07-20-funn-portfolio-optimiser-nullbyte.local.md` for the concrete
|
||||
null-byte reproduction that motivates the seam.)
|
||||
6
shared/examples/nav-golden-escape/SHOULD-NOT-BE-READ.md
Normal file
6
shared/examples/nav-golden-escape/SHOULD-NOT-BE-READ.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: project
|
||||
title: "Decoy — MUST NOT be read"
|
||||
---
|
||||
|
||||
This file sits ONE level above `bundle/`, outside the bundle. If its text ever appears in a read-context, the navigator resolved a `..` escape and breached the bundle boundary. It MUST never be reached.
|
||||
12
shared/examples/nav-golden-escape/bundle/index.md
Normal file
12
shared/examples/nav-golden-escape/bundle/index.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
type: index
|
||||
okf_version: 0.1
|
||||
title: "Nav-golden — escape / boundary case"
|
||||
---
|
||||
|
||||
Nav-golden escape case. Every link but the first escapes the bundle or is a root-relative trap; a conformant navigator skips them all, reads none of them, raises nothing, and still returns the one valid sibling.
|
||||
|
||||
- [Valid sibling](valid.md)
|
||||
- [Parent escape](../SHOULD-NOT-BE-READ.md)
|
||||
- [Deep escape](../../../../etc/passwd)
|
||||
- [Root-relative trap](/etc/passwd)
|
||||
6
shared/examples/nav-golden-escape/bundle/valid.md
Normal file
6
shared/examples/nav-golden-escape/bundle/valid.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: project
|
||||
title: "Valid sibling"
|
||||
---
|
||||
|
||||
The only in-bundle target. A conformant navigator returns exactly this file.
|
||||
10
shared/examples/nav-golden-escape/expected-read-context.md
Normal file
10
shared/examples/nav-golden-escape/expected-read-context.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
Nav-golden escape case. Every link but the first escapes the bundle or is a root-relative trap; a conformant navigator skips them all, reads none of them, raises nothing, and still returns the one valid sibling.
|
||||
|
||||
- [Valid sibling](valid.md)
|
||||
- [Parent escape](../SHOULD-NOT-BE-READ.md)
|
||||
- [Deep escape](../../../../etc/passwd)
|
||||
- [Root-relative trap](/etc/passwd)
|
||||
|
||||
## project: Valid sibling
|
||||
|
||||
The only in-bundle target. A conformant navigator returns exactly this file.
|
||||
34
shared/examples/nav-golden-hierarchy/README.md
Normal file
34
shared/examples/nav-golden-hierarchy/README.md
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
# nav-golden-hierarchy — hierarchical navigation golden
|
||||
|
||||
Fixture class **nav-golden** (commons-owned, per the D4 step-0 split): `bundle/` in,
|
||||
`expected-read-context.md` out. Unlike the ingest-golden class (ingest-spec §11,
|
||||
extraction-shaped: `manifest.json` → `expected-bundle/`), a nav-golden case is
|
||||
**bundle → read-context** — the only shape that can express the load-bearing property
|
||||
"two conformant implementations MUST produce an identical read-context from the same
|
||||
bundle" (method-spec §3 Step 1).
|
||||
|
||||
This **positive** case exercises every decision the Q3 navigation contract pins:
|
||||
|
||||
| Decision (method-spec §3 Step 1) | How this bundle exercises it |
|
||||
|---|---|
|
||||
| Hierarchy allowed; escape, not depth, forbidden | `a/`, `a/b/` are navigated; nothing escapes |
|
||||
| Link syntax: leading `/` = bundle root, else relative | `index.md`: relative `overview.md` + root-relative `/a/index.md`; `a/index.md`: relative `b/index.md` + root-relative `/overview.md` |
|
||||
| Depth-first, first-seen order | render order is `overview` → `doc-a` → `doc-b` |
|
||||
| Dedup on resolved path | `/overview.md` (from `a/`) resolves to the already-seen `overview.md` → one entry |
|
||||
| Cycle termination | `a/b/index.md` links back to `/a/index.md` (already seen) → stops |
|
||||
| One segment per level | each index links only its immediate children |
|
||||
| Missing `index.md` binds the root alone | `c/` has no `index.md` and nothing links `c/orphan.md`; it is simply unreachable, not an error |
|
||||
| Verdict exclusion = type check per reached file, recursive | `a/verdict-nested.md` is reached but excluded |
|
||||
| Flat render regardless of depth | nested concepts render as the same `## {type}: {title}` sections; no level heading; nested index bodies are navigation, not content, and are not rendered |
|
||||
|
||||
**Traversal trace:** `index.md` (its body is the leading summary) → `overview.md` →
|
||||
`/a/index.md` → `a/doc-a.md` → `a/verdict-nested.md` (reached, excluded) → `a/b/index.md`
|
||||
→ `a/b/doc-b.md` → `/a/index.md` (seen, deduped) → `/overview.md` (seen, deduped).
|
||||
Unreachable: `c/orphan.md`.
|
||||
|
||||
**Serialization** the gate compares against: the root index body verbatim, then each
|
||||
**non-index** concept as `## {type}: {title}` + blank line + the file body, sections
|
||||
separated by one blank line, file ending in exactly one trailing newline. The spec does
|
||||
not pin whitespace beyond this shape; a gate MAY compare byte-exact or after
|
||||
trailing-whitespace normalization. **Only the root index body is the summary** — nested
|
||||
index bodies (`a/index.md`, `a/b/index.md`) are navigation and do not appear.
|
||||
6
shared/examples/nav-golden-hierarchy/bundle/a/b/doc-b.md
Normal file
6
shared/examples/nav-golden-hierarchy/bundle/a/b/doc-b.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: reference
|
||||
title: "Doc B"
|
||||
---
|
||||
|
||||
Level-2 concept reached depth-first, deepest in the traversal.
|
||||
8
shared/examples/nav-golden-hierarchy/bundle/a/b/index.md
Normal file
8
shared/examples/nav-golden-hierarchy/bundle/a/b/index.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
type: index
|
||||
okf_version: 0.1
|
||||
title: "Subsection B index"
|
||||
---
|
||||
|
||||
- [Doc B](doc-b.md)
|
||||
- [Back to A](/a/index.md)
|
||||
6
shared/examples/nav-golden-hierarchy/bundle/a/doc-a.md
Normal file
6
shared/examples/nav-golden-hierarchy/bundle/a/doc-a.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: methodology
|
||||
title: "Doc A"
|
||||
---
|
||||
|
||||
Level-1 concept reached depth-first after Overview.
|
||||
10
shared/examples/nav-golden-hierarchy/bundle/a/index.md
Normal file
10
shared/examples/nav-golden-hierarchy/bundle/a/index.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
type: index
|
||||
okf_version: 0.1
|
||||
title: "Section A index"
|
||||
---
|
||||
|
||||
- [Doc A](doc-a.md)
|
||||
- [Nested verdict](verdict-nested.md)
|
||||
- [Subsection B](b/index.md)
|
||||
- [Overview again](/overview.md)
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
type: verdict
|
||||
title: "Nested verdict — must be excluded"
|
||||
decision: approved
|
||||
description: "A verdict file at a nested level. A conformant navigator reaches it (dedup marks it seen) but MUST exclude it from the read-context — recursively, not only at the root. This is the leakage surface a graph-based exclusion would miss."
|
||||
---
|
||||
|
||||
This body MUST NOT appear in the read-context.
|
||||
6
shared/examples/nav-golden-hierarchy/bundle/c/orphan.md
Normal file
6
shared/examples/nav-golden-hierarchy/bundle/c/orphan.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: project
|
||||
title: "Orphan — unreachable"
|
||||
---
|
||||
|
||||
Directory `c/` has no `index.md`, and nothing links to this file. A link-following navigator never reaches it; a directory-walking one wrongly would. It MUST be absent from the read-context, and its parent directory's missing `index.md` MUST NOT be an error (that rule binds the bundle root alone).
|
||||
10
shared/examples/nav-golden-hierarchy/bundle/index.md
Normal file
10
shared/examples/nav-golden-hierarchy/bundle/index.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
type: index
|
||||
okf_version: 0.1
|
||||
title: "Nav-golden — hierarchical navigation case"
|
||||
---
|
||||
|
||||
Nav-golden hierarchical case. This bundle exercises depth-first traversal, both link forms (root-relative and relative), recursive verdict exclusion, resolved-path de-duplication, cycle termination, and the root-only binding of the missing-index rule.
|
||||
|
||||
- [Overview](overview.md)
|
||||
- [Section A](/a/index.md)
|
||||
6
shared/examples/nav-golden-hierarchy/bundle/overview.md
Normal file
6
shared/examples/nav-golden-hierarchy/bundle/overview.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: project
|
||||
title: "Overview"
|
||||
---
|
||||
|
||||
Root-level concept reached by a relative link.
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
Nav-golden hierarchical case. This bundle exercises depth-first traversal, both link forms (root-relative and relative), recursive verdict exclusion, resolved-path de-duplication, cycle termination, and the root-only binding of the missing-index rule.
|
||||
|
||||
- [Overview](overview.md)
|
||||
- [Section A](/a/index.md)
|
||||
|
||||
## project: Overview
|
||||
|
||||
Root-level concept reached by a relative link.
|
||||
|
||||
## methodology: Doc A
|
||||
|
||||
Level-1 concept reached depth-first after Overview.
|
||||
|
||||
## reference: Doc B
|
||||
|
||||
Level-2 concept reached depth-first, deepest in the traversal.
|
||||
Loading…
Add table
Add a link
Reference in a new issue