Examples

Platform spec article

Examples

Back to Crate-to-spec anchors ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-feature-hub-authority Feature hub authority Accepted

   This feature hub owns normative MUST/SHOULD contract text for Crate-to-spec anchors.

   Context

   Sibling articles under this feature previously restated requirements in inconsistent forms.

   Decision

   This feature hub owns normative MUST/SHOULD contract text. Sibling articles must not redefine hub requirements and should link here for authority.

   Consequences

   Contract changes start on the hub or in linked ADRs, then propagate to articles and implementation anchors.

   Verification anchors

   • site/website/src/content/docs/platform-spec/compiler/implementation-map/crate-to-spec-anchors/index.mdx
   • article bundle under the same feature directory.

   Open full ADR page

2. 0002-spec-over-implementation-notes Specification over implementation notes Accepted

   Platform-spec text supersedes informal crate comments for Crate-to-spec anchors.

   Context

   Implementation crates accumulated informal notes that diverged from published contracts.

   Decision

   Normative platform-spec prose and ADRs under this feature supersede informal comments in implementation crates until explicitly migrated into spec text.

   Consequences

   Engineers file spec/ADR updates when behavior changes; crate comments are non-authoritative for conformance arguments.

   Verification anchors

   • compiler/crates/beskid_analysis/

   Open full ADR page

3. 0003-crate-map-single-index Crate-to-spec anchor map is canonical index Accepted

   Canonical index from compiler crates to platform-spec features.

   Context

   Crate references were scattered across hubs without a single ownership surface.

   Decision

   This feature hub is the canonical map from compiler/crates/* to platform-spec features; other pages link here instead of duplicating tables.

   Consequences

   New crates require anchor rows before Standard promotion of dependent features.

   Verification anchors

   • Implementation-map articles and compiler/Cargo.toml workspace layout.

   Open full ADR page

Articles

• Contracts and edge cases Normative guarantees and known edge cases for `Crate-to-spec anchors`. article Standard
• Design model Conceptual model for `Crate-to-spec anchors` and its subsystem boundaries. article Standard
• Examples Practical examples that demonstrate `Crate-to-spec anchors` behavior. article Standard
• FAQ and troubleshooting Common questions and debugging guidance for `Crate-to-spec anchors`. article Standard
• Flow and algorithm End-to-end control flow and major algorithmic steps for `Crate-to-spec anchors`. article Standard
• Verification and traceability How `Crate-to-spec anchors` requirements map to tests and implementation anchors. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 2 SpecSection(s) · 1 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Area
  Implementation map

  Parent area

• Domain
  Compiler

  Crate ownership boundaries are maintained inside the compiler domain

• Area
  Conformance

  The map is enforced by tests and review policy

• Feature
  Crate-to-spec anchors

  Parent feature hub

Example 1: Happy path

A standard project exercises the expected producer -> consumer handoff with no contract violations. Trace this via:

• “beskid_analysis -> parser/resolution/semantic leaves
• “beskid_abiandbeskid_runtime -> execution ABI/runtime leaves

Example 2: Contract mismatch

Intentionally alter a boundary definition (for example, a symbol or structure shape), then run the related conformance suite. The expected result is a deterministic failure that identifies the mismatched boundary.

Example 3: Regression-proofing a fix

After applying a fix, add or update a focused fixture in the nearest test crate and rerun wider suites so the behavior remains locked for future refactors.