Skip to content

Demonstrate a feature

A good feature page answers six questions:

  • Use case: what task does the setup make possible?
  • Source: which installer, package declaration, or managed configuration owns it?
  • Example: what exact command or interaction demonstrates it, with which prerequisites?
  • Observation: what should the reader see, and what was actually observed?
  • Limits: which services, accounts, hardware, or host checks remain outside the evidence?
  • References: where are the upstream manual and the local source of truth?

Update the guide and docs/_data/features.json with the implementation. The repository instructions and PR template make those updates part of finishing a change. The docs gate catches missing routes, source links, and executable mappings; review still needs to assess whether the explanation and demonstration are useful.

The setup configurator turns explicit choices into a reviewable shell command. It runs entirely in the browser; no installer is invoked by this page.

  1. Open the configurator on its default Core profile. Confirm local-model tooling is disabled.
  2. Select macOS → Full, enable shared-home isolation and local-model tooling.
  3. Confirm the command contains DF_PROFILE=full, DF_USE_PLAT=1, and DF_DO_LOCAL_LLM=1. Use Copy command and check its feedback.
  4. Select Linux. Confirm local-model tooling becomes unchecked and disabled, and the command changes to DF_DO_LOCAL_LLM=0.
Setup configurator with macOS, Full profile, platform isolation, and local-model tooling selected; the generated command shows the corresponding flags.
Actual local production preview on September 8, 2026. These controls and command changes were exercised; the screenshot does not establish a completed machine installation.

Searching for PLAT returned the isolation guide, runtime architecture, and individual troubleshooting diagnoses. Search is built with the handbook and served locally.

The handbook search dialog returns PLAT isolation, duplicate PATH diagnostics, migration guidance, and runtime architecture.

Name the file, highlight the setting that matters, and explain the effect. This excerpt from Ghostty’s managed source makes the clipboard policy visible:

home/dot_config/ghostty/config — excerpt
# Local selection and remote OSC 52 writes may update the clipboard.
copy-on-select = clipboard
clipboard-write = allow
clipboard-read = ask

For longer examples, collapse supporting lines and keep the changed behavior visible. The block below is an example evidence record, not a report of an actual Ghostty test:

Example evidence record
{
5 collapsed lines
"feature": "terminal-clipboard",
"source": "home/dot_config/ghostty/config",
"environment": "record OS, architecture, and app versions",
"command": "record the exact command or interaction",
"capturedAt": "record the UTC timestamp",
"expected": "remote copy updates the local clipboard",
"observed": "record the actual result after testing",
"artifact": "record a relative artifact path",
"limitations": "record what this test did not establish"
}

Title, line-number, marker, and collapse syntax comes from Expressive Code. Copying a code block keeps its underlying text; annotations are presentation.

ChangeUseful demonstrationAdditional boundary
Shell/PATH configurationFresh login shell, resolved executable, representative commandExisting terminals retain old environment
Agent instruction or skillRepresentative task plus resulting artifact and checksOne success does not establish general model quality
MCP integrationDiscover tool, invoke bounded operation, verify resultDeclaration alone does not prove auth or permission
Browser/desktop workflowBefore/after interaction, focused screenshot, reopen resultBuild success does not prove UI behavior
Game/media pipelineRender, play, import, or reopen the editable artifactEmulator/host output may differ from target hardware
Performance changeRepeated samples, environment, command, raw valuesSeparate cold/warm runs and measured scope

Keep diagrams as accessible SVG. For screenshots, capture the actual interface, choose a focused viewport or crop, encode as WebP/AVIF, and inspect the encoded image. Do not manufacture a UI screenshot to stand in for a real test.

Encode a captured screenshot
cd site
node scripts/encode-media.mjs artifacts/capture.png public/media/feature.webp

The encoder limits width to 1600 pixels without upscaling, uses WebP quality 88, and rejects an image over 350 KiB. Add its dimensions, description, route, capture conditions, and hash to media.json. The published examples here total roughly 213 KiB across four screenshots; individual pages load their own images lazily.

Use performance measurements for reproducible build data, and the documentation authoring guide for the canonical validation loop.