DESIGN.md@examplesA

DESIGN.md@examples from footprintjs/footprint is a DESIGN.md file: the design rules coding agents follow in that repo.

Install it, pinned
mdr add footprintjs/footprint/examples/DESIGN.md@git:20261016.2acfc1e

Pins git:20261016.2acfc1e in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 14 of 14 checks passed
Kind
DESIGN.md file
Repository
footprintjs/footprint
Path
examples/DESIGN.md
Versions recorded
10
Latest version
git:20261016.2acfc1e, committed Oct 16, 2026
First version recorded
Apr 28, 2026
Size
13,710 bytes
Repository stars
21
License
MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Examples — Design & Coverage Plan

Examples serve as **integration tests**. Every `npm run test:examples` type-checks them against the library source via path mapping. If a contributor's PR breaks an example, CI catches it before merge.

## Folder Structure

```
examples/
├── building-blocks/              → Flowchart primitives (what you build with)
│   ├── 01-linear.ts
│   ├── 02-fork.ts
│   ├── 03-decider.ts
│   ├── 04-selector.ts
│   ├── 05-subflow.ts
│   ├── 06-loops.ts
│   ├── 07-structural-subflow.ts
│   └── 08-lazy-subflow.ts
│
├── runtime-features/             → During execution (what happens while stages run)
│   ├── streaming/
│   │   ├── 01-linear.ts          → basic streaming stage
│   │   ├── 02-subflow.ts         → streaming inside subflow
│   │   └── 03-loop.ts            → streaming in a loop
│   ├── pause-resume/
│   │   ├── 01-linear.ts          → basic pause/resume
│   │   ├── 02-decider.ts         → conditional pause (pause only on some branches)
│   │   ├── 03-subflow.ts         → pause inside subflow
│   │   ├── 08-interrupt.ts       → interrupt(scope, …) mid-stage; resume re-enters the stage top
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add footprintjs/footprint/examples/DESIGN.md@sha256:51e064f010376b55

The line at the top of this page pins the label git:20261016.2acfc1e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_2bgkwm37rg35i4se.svg)](https://markdownregistry.com/a/art_2bgkwm37rg35i4se)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 10 versions of this file, between Apr 28, 2026 and Oct 16, 2026, about one every 19 days.

versioncommittedcommitsizeaudit
git:20261016.2acfc1e latest2026-10-16 2acfc1e 13,710 BA view · diff
git:20261016.5bdd2732026-10-16 5bdd273 13,552 BA view · diff
git:20261016.cddca032026-10-16 cddca03 13,397 BA view · diff
git:20261016.509c9212026-10-16 509c921 13,245 BA view · diff
git:20261015.62c96fc2026-10-15 62c96fc 13,216 BA view · diff
git:20260928.ead52cc2026-09-28 ead52cc 13,013 BA view · diff
git:20260830.07d413c2026-08-30 07d413c 12,767 BA view · diff
git:20260806.0993e552026-08-06 0993e55 12,675 BA view · diff
git:20260802.37d9d382026-08-02 37d9d38 12,386 BA view · diff
git:20260428.81bf2cc2026-04-28 81bf2cc 11,975 BA view

Audit of the latest version

A  14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Size between 200 bytes and 200 KB (13710 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

footprintjs/footprint · 21 stars · license MIT · pushed 2026-11-08 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_2bgkwm37rg35i4se
GET https://markdownregistry.com/api/v1/resolve?ref=footprintjs/footprint/examples/DESIGN.md
GET https://markdownregistry.com/api/v1/blob/51e064f010376b558d95f121be4b3fa339dd874b7463ef17081ee18658743a9e

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: what DESIGN.md is and how agents use it · which agent file does what.

More from footprintjs/footprint

AGENTS.md AGENTS.md file
footprintjs/footprint · AGENTS.md
git:20261106.259c0a5 · audit A · 21 stars
CLAUDE.md CLAUDE.md file
footprintjs/footprint · CLAUDE.md
git:20261106.c0d8d59 · audit A · 21 stars
footprint SKILL.md skill
footprintjs/footprint · ai-instructions/claude-code/SKILL.md · Use when building flowchart pipelines with footprintjs: stages, decide and select branches, subflows, loops, retries…
git:20261106.259c0a5 · audit A · 21 stars

Every file in footprintjs/footprint

Browse by kind, by grade A, or by owner.