Skip to the content

// the contracts

Rules and guardrails

Useful automation needs clear contracts: who owns a page, what a field means, how failure behaves and which checks must pass before an output is used.

// page metadata

A schema gives a page a shape.

A type declares the kind of page. A versioned schema lists required and optional fields. A summary provides a short way in; aliases capture known alternative names. Registered labels help filtering, and explicit parentage helps navigation.

illustrative note · metadata
type: knowledge
schema: knowledge/3
summary: "A worked example of a bounded retry policy."
aliases: [Retry policy]
up: "[[Reliable systems]]"
authority: unreviewed
status: draft

Fields vary by page type, and missing facts stay unknown. A schema version validates structure; it does not verify an account's truth or turn a draft into an approved view. This made-up example remains an unreviewed draft when retrieved.

// working rules

Make expectations inspectable.

Separate guidance covers writing, code, diagrams and agent work. A rule should explain its reason and the check or review that holds it. Applying a rule to a task keeps the relevant scope and source version visible.

Writing for a landing page has a different job from writing a system guide. The landing page makes the purpose and next step clear; the guide carries the explanation, contracts and evidence. Readers can choose how deep to go.

Source labels matter throughout. Authored context, generated interpretation, a proposal and an approved view remain distinguishable when selected for a task.

// checks

Check a specific boundary.

Shape
A page follows its declared schema; changed pages use the current version.
Identity
Aliases and renames resolve explicitly. Similar names are not enough to merge two subjects.
Links
Destinations exist, ambiguity is visible and structural parent paths stay acyclic.
Ownership
A producer updates its own outputs; authored and protected sources retain their boundaries.
Freshness
Indexes, grouping pages, reference state and diagrams agree with the current source snapshot.
Retrieval
Known questions still reach useful anchors and their evidence after a change.
Privacy
Configured name and secret checks screen outgoing content; public release has a separate boundary.
Failure behavior
A stale, partial or over-budget operation stops or keeps permitted last-good results.

These checks establish particular structural and operational properties. Human review still owns meaning and public approval.

// repeatability and uncertainty

Make the next run ordinary.

The local workflow rebuilds dependent views, checks whether they agree and repeats within a fixed bound. A settled snapshot produces no further changes. Ownership and source hashes guard writes; staged-bundle checks catch outputs that would leave together in an inconsistent state.

A missing destination becomes review work, with its original reference preserved. A model interpretation stays labeled. A privacy hold keeps uncleared content from normal publication.

This public website contains curated descriptions, illustrative diagrams and a synthetic example. It does not publish the private graph or connect to its notes, indexes, credentials or review state.