Reframe the website around repeatable workflows #352

Description

@taras

Story

As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

Positioning decision

Use this as the primary tagline:

Turn documentation into repeatable workflows.

The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

“Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

Product narrative

The site should teach this progression:

  1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
  2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
  3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
  4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

  • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
  • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

Homepage content brief

This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

Intended first impression

Within the first screen and the first example, a visitor should understand four things:

  • the source is documentation people can read and review;
  • repeated parts become named Markdown components with typed inputs;
  • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
  • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

Suggested hero copy

Eyebrow: Open source · Early / experimental

Headline: Turn documentation into repeatable workflows.

Supporting copy:

Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

Primary action: Run your first document

Secondary actions: See an example · View on GitHub

“Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

Product economics: inference becomes an authored asset

Section heading: Pay for reasoning once. Run it repeatedly.

Supporting line:

Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

The cost advantage is amortization:

  • authoring and improving the executable procedure has an up-front reasoning cost;
  • deterministic steps do not incur repeated LLM interpretation on every run;
  • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
  • reduced interpretation also reduces latency, variance, retries, and human supervision.

Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

A compact alternate line is:

Use AI to write and improve the workflow—not reinterpret it every time it runs.

Do not publish a percentage or fixed savings claim until a representative benchmark compares:

  • input and output tokens;
  • agent turns and tool calls;
  • retries and human interventions;
  • end-to-end latency;
  • successful completion rate; and
  • ordinary script/runtime and external-service costs.

Primary example: publishable with current behavior

Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

review-instructions.md:

# Review repository instructions
<Glob include={["**/AGENTS.md"]} as="instructionPaths" />
<Eachin={instructionPaths}let="path"as="instructions">
## {path}
<Filepath={path} />
</Each>
<Agent>
<Promptas="review">
Review these repository instructions for contradictions and missing safeguards.
{instructions}
</Prompt>
</Agent>
<Filepath="reports/instruction-review.md">
# Instruction review
{review}
</File>
The saved report:
<Filepath="reports/instruction-review.md" />

Run it with:

xmd run review-instructions.md --default-agent codex

Every structural step has operational meaning:

  1. <Glob> deterministically selects the instruction files.
  2. <Each> applies the same read procedure to every selected path.
  3. <File> reads through the contextual filesystem capability.
  4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
  5. The write form of <File> atomically saves the review at a declared path.
  6. The read form renders the saved artifact back into the document.

The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

The page may present the example as a four-part visual:

Discover → Read repeatedly → Apply judgment → Save the result
<Glob> <Each> + <File> <Prompt> <File>
deterministic deterministic model tokens deterministic

Future durable example: publish only with its owning features

Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

# Update repository instructions
<Workspace>
<Worktree>
<Branchname="docs/instruction-review" />
<Glob include={["**/AGENTS.md"]} as="instructionPaths" />
<Agent>
<Promptas="changes">
Resolve contradictions in these repository instructions:
<Eachin={instructionPaths}let="path">
## {path}
<Filepath={path} />
</Each>
</Prompt>
</Agent>
<Filepath="reports/instruction-review.md">{changes}</File>
<Commit
paths={["reports/instruction-review.md"]}
message="Document instruction review"
as="commit"
/>
<PullRequest
commit={commit}
title="Document instruction review"
/>
</Worktree>
</Workspace>

This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

The accompanying explanation should emphasize:

  • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
  • known environmental effects are declarative and visible in the document;
  • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
  • completed durable effects are restored or reconciled rather than blindly repeated;
  • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
  • an unsupported imperative operation fails instead of escaping to the host.

Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

Execution-mode comparison

Add this comparison only as each row becomes shipped and documented:

xmd runxmd workflow
EnvironmentCurrent host environmentRetained provider-backed Workspace
Best forRunning and experimenting with executable documentsProcedures that must continue across executions
OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

Secondary use-case cards

After the primary example, show no more than three concise applications:

  1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
  2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
  3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

Current and future capability guardrail

Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

Claims to avoid

  • “Any Markdown becomes durable.”
  • “Commands run exactly once.”
  • “Workflows can run any native tool.”
  • “Agents are deterministic.”
  • “The diagnostic journal resumes a run.”
  • “A Workspace can rewind to any journal entry.”
  • “Reliable” without naming the implemented guarantee.

Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

Website changes

Homepage

  • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
  • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
  • Preserve the early/experimental disclosure.
  • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
  • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
  • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
  • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
  • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
  • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
  • Keep installation and GitHub/docs calls to action easy to find.

Metadata and navigation

  • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
  • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
  • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

Documentation entry points

  • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
  • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
  • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

Truthfulness and sequencing

The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

Implement the content in two truthful layers if necessary:

  1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
  2. Add the execution-mode and durability sections as their owning issues ship.

Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

Acceptance

  • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
  • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
  • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
  • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
  • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
  • No numeric savings claim appears without a reproducible representative benchmark.
  • The page presents readable documentation and reusable composition as the path to repeatable execution.
  • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
  • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
  • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
  • Homepage metadata and social copy use the same positioning.
  • The docs landing page and relevant CLI reference use consistent run and workflow language.
  • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
  • The site build and repository verification gates pass.

Related work

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
      Skip to content

      Reframe the website around repeatable workflows #352

      Description

      @taras

      Story

      As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

      Positioning decision

      Use this as the primary tagline:

      Turn documentation into repeatable workflows.

      The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

      Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

      “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

      Product narrative

      The site should teach this progression:

      1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
      2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
      3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
      4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

      The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

      The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

      • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
      • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

      Homepage content brief

      This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

      Intended first impression

      Within the first screen and the first example, a visitor should understand four things:

      • the source is documentation people can read and review;
      • repeated parts become named Markdown components with typed inputs;
      • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
      • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

      Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

      Suggested hero copy

      Eyebrow: Open source · Early / experimental

      Headline: Turn documentation into repeatable workflows.

      Supporting copy:

      Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

      Primary action: Run your first document

      Secondary actions: See an example · View on GitHub

      “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

      Product economics: inference becomes an authored asset

      Section heading: Pay for reasoning once. Run it repeatedly.

      Supporting line:

      Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

      An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

      The cost advantage is amortization:

      • authoring and improving the executable procedure has an up-front reasoning cost;
      • deterministic steps do not incur repeated LLM interpretation on every run;
      • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
      • reduced interpretation also reduces latency, variance, retries, and human supervision.

      Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

      A compact alternate line is:

      Use AI to write and improve the workflow—not reinterpret it every time it runs.

      Do not publish a percentage or fixed savings claim until a representative benchmark compares:

      • input and output tokens;
      • agent turns and tool calls;
      • retries and human interventions;
      • end-to-end latency;
      • successful completion rate; and
      • ordinary script/runtime and external-service costs.

      Primary example: publishable with current behavior

      Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

      This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

      review-instructions.md:

      # Review repository instructions
      <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
      <Eachin={instructionPaths}let="path"as="instructions">
      ## {path}
      <Filepath={path} />
      </Each>
      <Agent>
      <Promptas="review">
      Review these repository instructions for contradictions and missing safeguards.
      {instructions}
      </Prompt>
      </Agent>
      <Filepath="reports/instruction-review.md">
      # Instruction review
      {review}
      </File>
      The saved report:
      <Filepath="reports/instruction-review.md" />

      Run it with:

      xmd run review-instructions.md --default-agent codex

      Every structural step has operational meaning:

      1. <Glob> deterministically selects the instruction files.
      2. <Each> applies the same read procedure to every selected path.
      3. <File> reads through the contextual filesystem capability.
      4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
      5. The write form of <File> atomically saves the review at a declared path.
      6. The read form renders the saved artifact back into the document.

      The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

      This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

      The page may present the example as a four-part visual:

      Discover → Read repeatedly → Apply judgment → Save the result
      <Glob> <Each> + <File> <Prompt> <File>
      deterministic deterministic model tokens deterministic
      

      Future durable example: publish only with its owning features

      Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

      # Update repository instructions
      <Workspace>
      <Worktree>
      <Branchname="docs/instruction-review" />
      <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
      <Agent>
      <Promptas="changes">
      Resolve contradictions in these repository instructions:
      <Eachin={instructionPaths}let="path">
      ## {path}
      <Filepath={path} />
      </Each>
      </Prompt>
      </Agent>
      <Filepath="reports/instruction-review.md">{changes}</File>
      <Commit
      paths={["reports/instruction-review.md"]}
      message="Document instruction review"
      as="commit"
      />
      <PullRequest
      commit={commit}
      title="Document instruction review"
      />
      </Worktree>
      </Workspace>

      This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

      The accompanying explanation should emphasize:

      • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
      • known environmental effects are declarative and visible in the document;
      • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
      • completed durable effects are restored or reconciled rather than blindly repeated;
      • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
      • an unsupported imperative operation fails instead of escaping to the host.

      Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

      Execution-mode comparison

      Add this comparison only as each row becomes shipped and documented:

      xmd runxmd workflow
      EnvironmentCurrent host environmentRetained provider-backed Workspace
      Best forRunning and experimenting with executable documentsProcedures that must continue across executions
      OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
      JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
      InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
      Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

      The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

      Secondary use-case cards

      After the primary example, show no more than three concise applications:

      1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
      2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
      3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

      Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

      Current and future capability guardrail

      Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

      Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

      When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

      Claims to avoid

      • “Any Markdown becomes durable.”
      • “Commands run exactly once.”
      • “Workflows can run any native tool.”
      • “Agents are deterministic.”
      • “The diagnostic journal resumes a run.”
      • “A Workspace can rewind to any journal entry.”
      • “Reliable” without naming the implemented guarantee.

      Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

      Website changes

      Homepage

      • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
      • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
      • Preserve the early/experimental disclosure.
      • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
      • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
      • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
      • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
      • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
      • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
      • Keep installation and GitHub/docs calls to action easy to find.

      Metadata and navigation

      • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
      • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
      • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

      Documentation entry points

      • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
      • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
      • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

      Truthfulness and sequencing

      The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

      Implement the content in two truthful layers if necessary:

      1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
      2. Add the execution-mode and durability sections as their owning issues ship.

      Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

      Acceptance

      • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
      • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
      • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
      • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
      • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
      • No numeric savings claim appears without a reproducible representative benchmark.
      • The page presents readable documentation and reusable composition as the path to repeatable execution.
      • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
      • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
      • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
      • Homepage metadata and social copy use the same positioning.
      • The docs landing page and relevant CLI reference use consistent run and workflow language.
      • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
      • The site build and repository verification gates pass.

      Related work

      Activity

      Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

      Metadata

      Metadata

      Assignees

      No one assigned

        Labels

        No labels
        No labels

        Projects

        No projects

          Milestone

          No milestone

          Relationships

          None yet

          Development

          No branches or pull requests

          Issue actions

          , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
          Skip to content

          Reframe the website around repeatable workflows #352

          Description

          @taras

          Story

          As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

          Positioning decision

          Use this as the primary tagline:

          Turn documentation into repeatable workflows.

          The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

          Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

          “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

          Product narrative

          The site should teach this progression:

          1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
          2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
          3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
          4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

          The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

          The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

          • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
          • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

          Homepage content brief

          This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

          Intended first impression

          Within the first screen and the first example, a visitor should understand four things:

          • the source is documentation people can read and review;
          • repeated parts become named Markdown components with typed inputs;
          • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
          • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

          Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

          Suggested hero copy

          Eyebrow: Open source · Early / experimental

          Headline: Turn documentation into repeatable workflows.

          Supporting copy:

          Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

          Primary action: Run your first document

          Secondary actions: See an example · View on GitHub

          “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

          Product economics: inference becomes an authored asset

          Section heading: Pay for reasoning once. Run it repeatedly.

          Supporting line:

          Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

          An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

          The cost advantage is amortization:

          • authoring and improving the executable procedure has an up-front reasoning cost;
          • deterministic steps do not incur repeated LLM interpretation on every run;
          • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
          • reduced interpretation also reduces latency, variance, retries, and human supervision.

          Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

          A compact alternate line is:

          Use AI to write and improve the workflow—not reinterpret it every time it runs.

          Do not publish a percentage or fixed savings claim until a representative benchmark compares:

          • input and output tokens;
          • agent turns and tool calls;
          • retries and human interventions;
          • end-to-end latency;
          • successful completion rate; and
          • ordinary script/runtime and external-service costs.

          Primary example: publishable with current behavior

          Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

          This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

          review-instructions.md:

          # Review repository instructions
          <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
          <Eachin={instructionPaths}let="path"as="instructions">
          ## {path}
          <Filepath={path} />
          </Each>
          <Agent>
          <Promptas="review">
          Review these repository instructions for contradictions and missing safeguards.
          {instructions}
          </Prompt>
          </Agent>
          <Filepath="reports/instruction-review.md">
          # Instruction review
          {review}
          </File>
          The saved report:
          <Filepath="reports/instruction-review.md" />

          Run it with:

          xmd run review-instructions.md --default-agent codex

          Every structural step has operational meaning:

          1. <Glob> deterministically selects the instruction files.
          2. <Each> applies the same read procedure to every selected path.
          3. <File> reads through the contextual filesystem capability.
          4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
          5. The write form of <File> atomically saves the review at a declared path.
          6. The read form renders the saved artifact back into the document.

          The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

          This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

          The page may present the example as a four-part visual:

          Discover → Read repeatedly → Apply judgment → Save the result
          <Glob> <Each> + <File> <Prompt> <File>
          deterministic deterministic model tokens deterministic
          

          Future durable example: publish only with its owning features

          Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

          # Update repository instructions
          <Workspace>
          <Worktree>
          <Branchname="docs/instruction-review" />
          <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
          <Agent>
          <Promptas="changes">
          Resolve contradictions in these repository instructions:
          <Eachin={instructionPaths}let="path">
          ## {path}
          <Filepath={path} />
          </Each>
          </Prompt>
          </Agent>
          <Filepath="reports/instruction-review.md">{changes}</File>
          <Commit
          paths={["reports/instruction-review.md"]}
          message="Document instruction review"
          as="commit"
          />
          <PullRequest
          commit={commit}
          title="Document instruction review"
          />
          </Worktree>
          </Workspace>

          This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

          The accompanying explanation should emphasize:

          • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
          • known environmental effects are declarative and visible in the document;
          • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
          • completed durable effects are restored or reconciled rather than blindly repeated;
          • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
          • an unsupported imperative operation fails instead of escaping to the host.

          Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

          Execution-mode comparison

          Add this comparison only as each row becomes shipped and documented:

          xmd runxmd workflow
          EnvironmentCurrent host environmentRetained provider-backed Workspace
          Best forRunning and experimenting with executable documentsProcedures that must continue across executions
          OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
          JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
          InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
          Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

          The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

          Secondary use-case cards

          After the primary example, show no more than three concise applications:

          1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
          2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
          3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

          Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

          Current and future capability guardrail

          Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

          Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

          When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

          Claims to avoid

          • “Any Markdown becomes durable.”
          • “Commands run exactly once.”
          • “Workflows can run any native tool.”
          • “Agents are deterministic.”
          • “The diagnostic journal resumes a run.”
          • “A Workspace can rewind to any journal entry.”
          • “Reliable” without naming the implemented guarantee.

          Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

          Website changes

          Homepage

          • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
          • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
          • Preserve the early/experimental disclosure.
          • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
          • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
          • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
          • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
          • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
          • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
          • Keep installation and GitHub/docs calls to action easy to find.

          Metadata and navigation

          • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
          • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
          • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

          Documentation entry points

          • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
          • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
          • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

          Truthfulness and sequencing

          The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

          Implement the content in two truthful layers if necessary:

          1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
          2. Add the execution-mode and durability sections as their owning issues ship.

          Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

          Acceptance

          • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
          • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
          • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
          • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
          • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
          • No numeric savings claim appears without a reproducible representative benchmark.
          • The page presents readable documentation and reusable composition as the path to repeatable execution.
          • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
          • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
          • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
          • Homepage metadata and social copy use the same positioning.
          • The docs landing page and relevant CLI reference use consistent run and workflow language.
          • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
          • The site build and repository verification gates pass.

          Related work

          Activity

          Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

          Metadata

          Metadata

          Assignees

          No one assigned

            Labels

            No labels
            No labels

            Projects

            No projects

              Milestone

              No milestone

              Relationships

              None yet

              Development

              No branches or pull requests

              Issue actions

              , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
              Skip to content

              Reframe the website around repeatable workflows #352

              Description

              @taras

              Story

              As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

              Positioning decision

              Use this as the primary tagline:

              Turn documentation into repeatable workflows.

              The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

              Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

              “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

              Product narrative

              The site should teach this progression:

              1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
              2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
              3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
              4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

              The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

              The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

              • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
              • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

              Homepage content brief

              This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

              Intended first impression

              Within the first screen and the first example, a visitor should understand four things:

              • the source is documentation people can read and review;
              • repeated parts become named Markdown components with typed inputs;
              • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
              • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

              Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

              Suggested hero copy

              Eyebrow: Open source · Early / experimental

              Headline: Turn documentation into repeatable workflows.

              Supporting copy:

              Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

              Primary action: Run your first document

              Secondary actions: See an example · View on GitHub

              “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

              Product economics: inference becomes an authored asset

              Section heading: Pay for reasoning once. Run it repeatedly.

              Supporting line:

              Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

              An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

              The cost advantage is amortization:

              • authoring and improving the executable procedure has an up-front reasoning cost;
              • deterministic steps do not incur repeated LLM interpretation on every run;
              • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
              • reduced interpretation also reduces latency, variance, retries, and human supervision.

              Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

              A compact alternate line is:

              Use AI to write and improve the workflow—not reinterpret it every time it runs.

              Do not publish a percentage or fixed savings claim until a representative benchmark compares:

              • input and output tokens;
              • agent turns and tool calls;
              • retries and human interventions;
              • end-to-end latency;
              • successful completion rate; and
              • ordinary script/runtime and external-service costs.

              Primary example: publishable with current behavior

              Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

              This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

              review-instructions.md:

              # Review repository instructions
              <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
              <Eachin={instructionPaths}let="path"as="instructions">
              ## {path}
              <Filepath={path} />
              </Each>
              <Agent>
              <Promptas="review">
              Review these repository instructions for contradictions and missing safeguards.
              {instructions}
              </Prompt>
              </Agent>
              <Filepath="reports/instruction-review.md">
              # Instruction review
              {review}
              </File>
              The saved report:
              <Filepath="reports/instruction-review.md" />

              Run it with:

              xmd run review-instructions.md --default-agent codex

              Every structural step has operational meaning:

              1. <Glob> deterministically selects the instruction files.
              2. <Each> applies the same read procedure to every selected path.
              3. <File> reads through the contextual filesystem capability.
              4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
              5. The write form of <File> atomically saves the review at a declared path.
              6. The read form renders the saved artifact back into the document.

              The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

              This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

              The page may present the example as a four-part visual:

              Discover → Read repeatedly → Apply judgment → Save the result
              <Glob> <Each> + <File> <Prompt> <File>
              deterministic deterministic model tokens deterministic
              

              Future durable example: publish only with its owning features

              Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

              # Update repository instructions
              <Workspace>
              <Worktree>
              <Branchname="docs/instruction-review" />
              <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
              <Agent>
              <Promptas="changes">
              Resolve contradictions in these repository instructions:
              <Eachin={instructionPaths}let="path">
              ## {path}
              <Filepath={path} />
              </Each>
              </Prompt>
              </Agent>
              <Filepath="reports/instruction-review.md">{changes}</File>
              <Commit
              paths={["reports/instruction-review.md"]}
              message="Document instruction review"
              as="commit"
              />
              <PullRequest
              commit={commit}
              title="Document instruction review"
              />
              </Worktree>
              </Workspace>

              This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

              The accompanying explanation should emphasize:

              • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
              • known environmental effects are declarative and visible in the document;
              • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
              • completed durable effects are restored or reconciled rather than blindly repeated;
              • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
              • an unsupported imperative operation fails instead of escaping to the host.

              Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

              Execution-mode comparison

              Add this comparison only as each row becomes shipped and documented:

              xmd runxmd workflow
              EnvironmentCurrent host environmentRetained provider-backed Workspace
              Best forRunning and experimenting with executable documentsProcedures that must continue across executions
              OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
              JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
              InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
              Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

              The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

              Secondary use-case cards

              After the primary example, show no more than three concise applications:

              1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
              2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
              3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

              Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

              Current and future capability guardrail

              Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

              Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

              When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

              Claims to avoid

              • “Any Markdown becomes durable.”
              • “Commands run exactly once.”
              • “Workflows can run any native tool.”
              • “Agents are deterministic.”
              • “The diagnostic journal resumes a run.”
              • “A Workspace can rewind to any journal entry.”
              • “Reliable” without naming the implemented guarantee.

              Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

              Website changes

              Homepage

              • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
              • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
              • Preserve the early/experimental disclosure.
              • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
              • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
              • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
              • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
              • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
              • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
              • Keep installation and GitHub/docs calls to action easy to find.

              Metadata and navigation

              • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
              • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
              • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

              Documentation entry points

              • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
              • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
              • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

              Truthfulness and sequencing

              The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

              Implement the content in two truthful layers if necessary:

              1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
              2. Add the execution-mode and durability sections as their owning issues ship.

              Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

              Acceptance

              • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
              • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
              • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
              • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
              • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
              • No numeric savings claim appears without a reproducible representative benchmark.
              • The page presents readable documentation and reusable composition as the path to repeatable execution.
              • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
              • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
              • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
              • Homepage metadata and social copy use the same positioning.
              • The docs landing page and relevant CLI reference use consistent run and workflow language.
              • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
              • The site build and repository verification gates pass.

              Related work

              Activity

              Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

              Metadata

              Metadata

              Assignees

              No one assigned

                Labels

                No labels
                No labels

                Projects

                No projects

                  Milestone

                  No milestone

                  Relationships

                  None yet

                  Development

                  No branches or pull requests

                  Issue actions

                  , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
                  Skip to content

                  Reframe the website around repeatable workflows #352

                  Description

                  @taras

                  Story

                  As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

                  Positioning decision

                  Use this as the primary tagline:

                  Turn documentation into repeatable workflows.

                  The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

                  Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

                  “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

                  Product narrative

                  The site should teach this progression:

                  1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
                  2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
                  3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
                  4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

                  The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

                  The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

                  • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
                  • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

                  Homepage content brief

                  This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

                  Intended first impression

                  Within the first screen and the first example, a visitor should understand four things:

                  • the source is documentation people can read and review;
                  • repeated parts become named Markdown components with typed inputs;
                  • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
                  • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

                  Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

                  Suggested hero copy

                  Eyebrow: Open source · Early / experimental

                  Headline: Turn documentation into repeatable workflows.

                  Supporting copy:

                  Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

                  Primary action: Run your first document

                  Secondary actions: See an example · View on GitHub

                  “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

                  Product economics: inference becomes an authored asset

                  Section heading: Pay for reasoning once. Run it repeatedly.

                  Supporting line:

                  Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

                  An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

                  The cost advantage is amortization:

                  • authoring and improving the executable procedure has an up-front reasoning cost;
                  • deterministic steps do not incur repeated LLM interpretation on every run;
                  • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
                  • reduced interpretation also reduces latency, variance, retries, and human supervision.

                  Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

                  A compact alternate line is:

                  Use AI to write and improve the workflow—not reinterpret it every time it runs.

                  Do not publish a percentage or fixed savings claim until a representative benchmark compares:

                  • input and output tokens;
                  • agent turns and tool calls;
                  • retries and human interventions;
                  • end-to-end latency;
                  • successful completion rate; and
                  • ordinary script/runtime and external-service costs.

                  Primary example: publishable with current behavior

                  Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

                  This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

                  review-instructions.md:

                  # Review repository instructions
                  <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                  <Eachin={instructionPaths}let="path"as="instructions">
                  ## {path}
                  <Filepath={path} />
                  </Each>
                  <Agent>
                  <Promptas="review">
                  Review these repository instructions for contradictions and missing safeguards.
                  {instructions}
                  </Prompt>
                  </Agent>
                  <Filepath="reports/instruction-review.md">
                  # Instruction review
                  {review}
                  </File>
                  The saved report:
                  <Filepath="reports/instruction-review.md" />

                  Run it with:

                  xmd run review-instructions.md --default-agent codex

                  Every structural step has operational meaning:

                  1. <Glob> deterministically selects the instruction files.
                  2. <Each> applies the same read procedure to every selected path.
                  3. <File> reads through the contextual filesystem capability.
                  4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
                  5. The write form of <File> atomically saves the review at a declared path.
                  6. The read form renders the saved artifact back into the document.

                  The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

                  This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

                  The page may present the example as a four-part visual:

                  Discover → Read repeatedly → Apply judgment → Save the result
                  <Glob> <Each> + <File> <Prompt> <File>
                  deterministic deterministic model tokens deterministic
                  

                  Future durable example: publish only with its owning features

                  Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

                  # Update repository instructions
                  <Workspace>
                  <Worktree>
                  <Branchname="docs/instruction-review" />
                  <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                  <Agent>
                  <Promptas="changes">
                  Resolve contradictions in these repository instructions:
                  <Eachin={instructionPaths}let="path">
                  ## {path}
                  <Filepath={path} />
                  </Each>
                  </Prompt>
                  </Agent>
                  <Filepath="reports/instruction-review.md">{changes}</File>
                  <Commit
                  paths={["reports/instruction-review.md"]}
                  message="Document instruction review"
                  as="commit"
                  />
                  <PullRequest
                  commit={commit}
                  title="Document instruction review"
                  />
                  </Worktree>
                  </Workspace>

                  This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

                  The accompanying explanation should emphasize:

                  • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
                  • known environmental effects are declarative and visible in the document;
                  • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
                  • completed durable effects are restored or reconciled rather than blindly repeated;
                  • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
                  • an unsupported imperative operation fails instead of escaping to the host.

                  Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

                  Execution-mode comparison

                  Add this comparison only as each row becomes shipped and documented:

                  xmd runxmd workflow
                  EnvironmentCurrent host environmentRetained provider-backed Workspace
                  Best forRunning and experimenting with executable documentsProcedures that must continue across executions
                  OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
                  JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
                  InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
                  Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

                  The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

                  Secondary use-case cards

                  After the primary example, show no more than three concise applications:

                  1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
                  2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
                  3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

                  Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

                  Current and future capability guardrail

                  Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

                  Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

                  When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

                  Claims to avoid

                  • “Any Markdown becomes durable.”
                  • “Commands run exactly once.”
                  • “Workflows can run any native tool.”
                  • “Agents are deterministic.”
                  • “The diagnostic journal resumes a run.”
                  • “A Workspace can rewind to any journal entry.”
                  • “Reliable” without naming the implemented guarantee.

                  Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

                  Website changes

                  Homepage

                  • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
                  • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
                  • Preserve the early/experimental disclosure.
                  • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
                  • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
                  • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
                  • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
                  • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
                  • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
                  • Keep installation and GitHub/docs calls to action easy to find.

                  Metadata and navigation

                  • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
                  • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
                  • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

                  Documentation entry points

                  • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
                  • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
                  • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

                  Truthfulness and sequencing

                  The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

                  Implement the content in two truthful layers if necessary:

                  1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
                  2. Add the execution-mode and durability sections as their owning issues ship.

                  Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

                  Acceptance

                  • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
                  • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
                  • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
                  • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
                  • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
                  • No numeric savings claim appears without a reproducible representative benchmark.
                  • The page presents readable documentation and reusable composition as the path to repeatable execution.
                  • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
                  • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
                  • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
                  • Homepage metadata and social copy use the same positioning.
                  • The docs landing page and relevant CLI reference use consistent run and workflow language.
                  • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
                  • The site build and repository verification gates pass.

                  Related work

                  Activity

                  Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

                  Metadata

                  Metadata

                  Assignees

                  No one assigned

                    Labels

                    No labels
                    No labels

                    Projects

                    No projects

                      Milestone

                      No milestone

                      Relationships

                      None yet

                      Development

                      No branches or pull requests

                      Issue actions

                      , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
                      Skip to content

                      Reframe the website around repeatable workflows #352

                      Description

                      @taras

                      Story

                      As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

                      Positioning decision

                      Use this as the primary tagline:

                      Turn documentation into repeatable workflows.

                      The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

                      Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

                      “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

                      Product narrative

                      The site should teach this progression:

                      1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
                      2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
                      3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
                      4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

                      The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

                      The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

                      • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
                      • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

                      Homepage content brief

                      This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

                      Intended first impression

                      Within the first screen and the first example, a visitor should understand four things:

                      • the source is documentation people can read and review;
                      • repeated parts become named Markdown components with typed inputs;
                      • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
                      • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

                      Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

                      Suggested hero copy

                      Eyebrow: Open source · Early / experimental

                      Headline: Turn documentation into repeatable workflows.

                      Supporting copy:

                      Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

                      Primary action: Run your first document

                      Secondary actions: See an example · View on GitHub

                      “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

                      Product economics: inference becomes an authored asset

                      Section heading: Pay for reasoning once. Run it repeatedly.

                      Supporting line:

                      Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

                      An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

                      The cost advantage is amortization:

                      • authoring and improving the executable procedure has an up-front reasoning cost;
                      • deterministic steps do not incur repeated LLM interpretation on every run;
                      • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
                      • reduced interpretation also reduces latency, variance, retries, and human supervision.

                      Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

                      A compact alternate line is:

                      Use AI to write and improve the workflow—not reinterpret it every time it runs.

                      Do not publish a percentage or fixed savings claim until a representative benchmark compares:

                      • input and output tokens;
                      • agent turns and tool calls;
                      • retries and human interventions;
                      • end-to-end latency;
                      • successful completion rate; and
                      • ordinary script/runtime and external-service costs.

                      Primary example: publishable with current behavior

                      Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

                      This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

                      review-instructions.md:

                      # Review repository instructions
                      <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                      <Eachin={instructionPaths}let="path"as="instructions">
                      ## {path}
                      <Filepath={path} />
                      </Each>
                      <Agent>
                      <Promptas="review">
                      Review these repository instructions for contradictions and missing safeguards.
                      {instructions}
                      </Prompt>
                      </Agent>
                      <Filepath="reports/instruction-review.md">
                      # Instruction review
                      {review}
                      </File>
                      The saved report:
                      <Filepath="reports/instruction-review.md" />

                      Run it with:

                      xmd run review-instructions.md --default-agent codex

                      Every structural step has operational meaning:

                      1. <Glob> deterministically selects the instruction files.
                      2. <Each> applies the same read procedure to every selected path.
                      3. <File> reads through the contextual filesystem capability.
                      4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
                      5. The write form of <File> atomically saves the review at a declared path.
                      6. The read form renders the saved artifact back into the document.

                      The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

                      This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

                      The page may present the example as a four-part visual:

                      Discover → Read repeatedly → Apply judgment → Save the result
                      <Glob> <Each> + <File> <Prompt> <File>
                      deterministic deterministic model tokens deterministic
                      

                      Future durable example: publish only with its owning features

                      Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

                      # Update repository instructions
                      <Workspace>
                      <Worktree>
                      <Branchname="docs/instruction-review" />
                      <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                      <Agent>
                      <Promptas="changes">
                      Resolve contradictions in these repository instructions:
                      <Eachin={instructionPaths}let="path">
                      ## {path}
                      <Filepath={path} />
                      </Each>
                      </Prompt>
                      </Agent>
                      <Filepath="reports/instruction-review.md">{changes}</File>
                      <Commit
                      paths={["reports/instruction-review.md"]}
                      message="Document instruction review"
                      as="commit"
                      />
                      <PullRequest
                      commit={commit}
                      title="Document instruction review"
                      />
                      </Worktree>
                      </Workspace>

                      This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

                      The accompanying explanation should emphasize:

                      • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
                      • known environmental effects are declarative and visible in the document;
                      • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
                      • completed durable effects are restored or reconciled rather than blindly repeated;
                      • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
                      • an unsupported imperative operation fails instead of escaping to the host.

                      Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

                      Execution-mode comparison

                      Add this comparison only as each row becomes shipped and documented:

                      xmd runxmd workflow
                      EnvironmentCurrent host environmentRetained provider-backed Workspace
                      Best forRunning and experimenting with executable documentsProcedures that must continue across executions
                      OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
                      JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
                      InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
                      Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

                      The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

                      Secondary use-case cards

                      After the primary example, show no more than three concise applications:

                      1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
                      2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
                      3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

                      Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

                      Current and future capability guardrail

                      Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

                      Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

                      When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

                      Claims to avoid

                      • “Any Markdown becomes durable.”
                      • “Commands run exactly once.”
                      • “Workflows can run any native tool.”
                      • “Agents are deterministic.”
                      • “The diagnostic journal resumes a run.”
                      • “A Workspace can rewind to any journal entry.”
                      • “Reliable” without naming the implemented guarantee.

                      Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

                      Website changes

                      Homepage

                      • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
                      • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
                      • Preserve the early/experimental disclosure.
                      • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
                      • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
                      • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
                      • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
                      • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
                      • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
                      • Keep installation and GitHub/docs calls to action easy to find.

                      Metadata and navigation

                      • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
                      • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
                      • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

                      Documentation entry points

                      • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
                      • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
                      • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

                      Truthfulness and sequencing

                      The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

                      Implement the content in two truthful layers if necessary:

                      1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
                      2. Add the execution-mode and durability sections as their owning issues ship.

                      Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

                      Acceptance

                      • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
                      • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
                      • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
                      • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
                      • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
                      • No numeric savings claim appears without a reproducible representative benchmark.
                      • The page presents readable documentation and reusable composition as the path to repeatable execution.
                      • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
                      • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
                      • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
                      • Homepage metadata and social copy use the same positioning.
                      • The docs landing page and relevant CLI reference use consistent run and workflow language.
                      • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
                      • The site build and repository verification gates pass.

                      Related work

                      Activity

                      Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

                      Metadata

                      Metadata

                      Assignees

                      No one assigned

                        Labels

                        No labels
                        No labels

                        Projects

                        No projects

                          Milestone

                          No milestone

                          Relationships

                          None yet

                          Development

                          No branches or pull requests

                          Issue actions

                          , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
                          Skip to content

                          Reframe the website around repeatable workflows #352

                          Description

                          @taras

                          Story

                          As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

                          Positioning decision

                          Use this as the primary tagline:

                          Turn documentation into repeatable workflows.

                          The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

                          Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

                          “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

                          Product narrative

                          The site should teach this progression:

                          1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
                          2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
                          3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
                          4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

                          The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

                          The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

                          • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
                          • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

                          Homepage content brief

                          This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

                          Intended first impression

                          Within the first screen and the first example, a visitor should understand four things:

                          • the source is documentation people can read and review;
                          • repeated parts become named Markdown components with typed inputs;
                          • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
                          • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

                          Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

                          Suggested hero copy

                          Eyebrow: Open source · Early / experimental

                          Headline: Turn documentation into repeatable workflows.

                          Supporting copy:

                          Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

                          Primary action: Run your first document

                          Secondary actions: See an example · View on GitHub

                          “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

                          Product economics: inference becomes an authored asset

                          Section heading: Pay for reasoning once. Run it repeatedly.

                          Supporting line:

                          Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

                          An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

                          The cost advantage is amortization:

                          • authoring and improving the executable procedure has an up-front reasoning cost;
                          • deterministic steps do not incur repeated LLM interpretation on every run;
                          • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
                          • reduced interpretation also reduces latency, variance, retries, and human supervision.

                          Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

                          A compact alternate line is:

                          Use AI to write and improve the workflow—not reinterpret it every time it runs.

                          Do not publish a percentage or fixed savings claim until a representative benchmark compares:

                          • input and output tokens;
                          • agent turns and tool calls;
                          • retries and human interventions;
                          • end-to-end latency;
                          • successful completion rate; and
                          • ordinary script/runtime and external-service costs.

                          Primary example: publishable with current behavior

                          Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

                          This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

                          review-instructions.md:

                          # Review repository instructions
                          <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                          <Eachin={instructionPaths}let="path"as="instructions">
                          ## {path}
                          <Filepath={path} />
                          </Each>
                          <Agent>
                          <Promptas="review">
                          Review these repository instructions for contradictions and missing safeguards.
                          {instructions}
                          </Prompt>
                          </Agent>
                          <Filepath="reports/instruction-review.md">
                          # Instruction review
                          {review}
                          </File>
                          The saved report:
                          <Filepath="reports/instruction-review.md" />

                          Run it with:

                          xmd run review-instructions.md --default-agent codex

                          Every structural step has operational meaning:

                          1. <Glob> deterministically selects the instruction files.
                          2. <Each> applies the same read procedure to every selected path.
                          3. <File> reads through the contextual filesystem capability.
                          4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
                          5. The write form of <File> atomically saves the review at a declared path.
                          6. The read form renders the saved artifact back into the document.

                          The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

                          This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

                          The page may present the example as a four-part visual:

                          Discover → Read repeatedly → Apply judgment → Save the result
                          <Glob> <Each> + <File> <Prompt> <File>
                          deterministic deterministic model tokens deterministic
                          

                          Future durable example: publish only with its owning features

                          Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

                          # Update repository instructions
                          <Workspace>
                          <Worktree>
                          <Branchname="docs/instruction-review" />
                          <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                          <Agent>
                          <Promptas="changes">
                          Resolve contradictions in these repository instructions:
                          <Eachin={instructionPaths}let="path">
                          ## {path}
                          <Filepath={path} />
                          </Each>
                          </Prompt>
                          </Agent>
                          <Filepath="reports/instruction-review.md">{changes}</File>
                          <Commit
                          paths={["reports/instruction-review.md"]}
                          message="Document instruction review"
                          as="commit"
                          />
                          <PullRequest
                          commit={commit}
                          title="Document instruction review"
                          />
                          </Worktree>
                          </Workspace>

                          This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

                          The accompanying explanation should emphasize:

                          • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
                          • known environmental effects are declarative and visible in the document;
                          • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
                          • completed durable effects are restored or reconciled rather than blindly repeated;
                          • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
                          • an unsupported imperative operation fails instead of escaping to the host.

                          Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

                          Execution-mode comparison

                          Add this comparison only as each row becomes shipped and documented:

                          xmd runxmd workflow
                          EnvironmentCurrent host environmentRetained provider-backed Workspace
                          Best forRunning and experimenting with executable documentsProcedures that must continue across executions
                          OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
                          JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
                          InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
                          Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

                          The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

                          Secondary use-case cards

                          After the primary example, show no more than three concise applications:

                          1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
                          2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
                          3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

                          Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

                          Current and future capability guardrail

                          Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

                          Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

                          When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

                          Claims to avoid

                          • “Any Markdown becomes durable.”
                          • “Commands run exactly once.”
                          • “Workflows can run any native tool.”
                          • “Agents are deterministic.”
                          • “The diagnostic journal resumes a run.”
                          • “A Workspace can rewind to any journal entry.”
                          • “Reliable” without naming the implemented guarantee.

                          Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

                          Website changes

                          Homepage

                          • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
                          • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
                          • Preserve the early/experimental disclosure.
                          • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
                          • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
                          • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
                          • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
                          • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
                          • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
                          • Keep installation and GitHub/docs calls to action easy to find.

                          Metadata and navigation

                          • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
                          • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
                          • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

                          Documentation entry points

                          • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
                          • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
                          • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

                          Truthfulness and sequencing

                          The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

                          Implement the content in two truthful layers if necessary:

                          1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
                          2. Add the execution-mode and durability sections as their owning issues ship.

                          Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

                          Acceptance

                          • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
                          • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
                          • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
                          • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
                          • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
                          • No numeric savings claim appears without a reproducible representative benchmark.
                          • The page presents readable documentation and reusable composition as the path to repeatable execution.
                          • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
                          • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
                          • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
                          • Homepage metadata and social copy use the same positioning.
                          • The docs landing page and relevant CLI reference use consistent run and workflow language.
                          • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
                          • The site build and repository verification gates pass.

                          Related work

                          Activity

                          Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

                          Metadata

                          Metadata

                          Assignees

                          No one assigned

                            Labels

                            No labels
                            No labels

                            Projects

                            No projects

                              Milestone

                              No milestone

                              Relationships

                              None yet

                              Development

                              No branches or pull requests

                              Issue actions

                              , 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
                              Skip to content

                              Reframe the website around repeatable workflows #352

                              Description

                              @taras

                              Story

                              As someone discovering Executable.md, I want the website to explain that it turns documented procedures into repeatable workflows, so I understand the product outcome rather than seeing only a list of Markdown execution features.

                              Positioning decision

                              Use this as the primary tagline:

                              Turn documentation into repeatable workflows.

                              The active verb makes the product’s role explicit: Executable.md is what turns an existing documented procedure into something people can run repeatedly. “Repeatable” remains the central promise. It distinguishes Executable.md from open-ended agent harnesses whose job is to reach a goal despite changing obstacles. Executable.md systematizes procedures that are understood well enough to document and need to run consistently again.

                              Use reliable and resumable as supporting benefits when the surrounding copy names the concrete behavior that earns those claims. Use reusable for component composition and sharing, but not as the primary tagline.

                              “Markdown that runs” can remain as a compact product description, but it no longer carries the hero message by itself.

                              Product narrative

                              The site should teach this progression:

                              1. Document the procedure. The source remains readable Markdown that renders normally in GitHub, editors, and other Markdown viewers.
                              2. Compose the procedure. Components, props, content slots, providers, and declarative operations turn repeated instructions into named, reusable building blocks.
                              3. Run the procedure.xmd run executes the document against the current environment with ordinary operation-level correctness.
                              4. Make it repeatable.xmd workflow executes supported operations in a constrained, retained environment so a workflow can reattach and continue after interruption.

                              The constrained workflow environment is a feature rather than a limitation. Durable workflows do not require arbitrary native command compatibility. Declarative components such as <Dir>, <File>, <Branch>, and <Commit> express intent through contextual capabilities. Optional shell and JavaScript execution add imperative flexibility only where the environment can support it safely.

                              The same declarative document can run in both modes. Durability is supplied by the host and its installed capabilities:

                              • xmd run uses ordinary host capabilities and does not promise Workspace retention, reattachment, or continuation.
                              • xmd workflow uses durable Workspace-backed capabilities and never silently falls back to unrelated host filesystem or process behavior.

                              Homepage content brief

                              This section is implementation guidance for the website agent. It supplies examples and copy direction; it does not make unshipped syntax part of the public contract.

                              Intended first impression

                              Within the first screen and the first example, a visitor should understand four things:

                              • the source is documentation people can read and review;
                              • repeated parts become named Markdown components with typed inputs;
                              • xmd runs the documented procedure instead of asking a person to translate it into ad hoc commands; and
                              • repeatability comes from making intent explicit, while durable continuation is an additional guarantee of xmd workflow once shipped.

                              Do not open with MDX, Effection, middleware, modifier chains, V8, or journal internals. Those explain how the product works after the outcome is clear.

                              Suggested hero copy

                              Eyebrow: Open source · Early / experimental

                              Headline: Turn documentation into repeatable workflows.

                              Supporting copy:

                              Executable.md keeps procedures readable as Markdown, then gives them reusable components, typed inputs, and executable steps so the same process can run consistently.

                              Primary action: Run your first document

                              Secondary actions: See an example · View on GitHub

                              “Markdown that runs” may appear as a short explanatory phrase below the hero or in metadata, but not as the primary value proposition.

                              Product economics: inference becomes an authored asset

                              Section heading: Pay for reasoning once. Run it repeatedly.

                              Supporting line:

                              Spend tokens defining and improving the workflow—not asking a model to reinterpret every deterministic step each time it runs.

                              An instruction-only document leaves the entire procedure probabilistic on every invocation: a model reads it, reconstructs the plan, chooses tools and arguments, resolves ambiguities, and often verifies or retries the work. Executable.md lets a human or AI encode the stable parts once as a Markdown script. File discovery, input validation, control flow, filesystem changes, Git effects, and other declared operations then execute directly. Model calls remain visible in the document and are reserved for steps that actually require judgment.

                              The cost advantage is amortization:

                              • authoring and improving the executable procedure has an up-front reasoning cost;
                              • deterministic steps do not incur repeated LLM interpretation on every run;
                              • per-run token cost is limited to the explicit agent or sampling steps the workflow contains; and
                              • reduced interpretation also reduces latency, variance, retries, and human supervision.

                              Do not claim that every workflow pays for tokens literally once. A workflow containing <Prompt>, <Sample>, or another probabilistic step still spends tokens when that step runs. The defensible claim is that the deterministic portion stops paying an interpretation cost on every execution.

                              A compact alternate line is:

                              Use AI to write and improve the workflow—not reinterpret it every time it runs.

                              Do not publish a percentage or fixed savings claim until a representative benchmark compares:

                              • input and output tokens;
                              • agent turns and tool calls;
                              • retries and human interventions;
                              • end-to-end latency;
                              • successful completion rate; and
                              • ordinary script/runtime and external-service costs.

                              Primary example: publishable with current behavior

                              Lead with a workflow whose visible steps perform work. A prose checklist is still only documentation; it does not show why making the document executable changes the result.

                              This example deterministically discovers and reads repository instructions, uses an agent only for the judgment step, then writes the resulting review:

                              review-instructions.md:

                              # Review repository instructions
                              <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                              <Eachin={instructionPaths}let="path"as="instructions">
                              ## {path}
                              <Filepath={path} />
                              </Each>
                              <Agent>
                              <Promptas="review">
                              Review these repository instructions for contradictions and missing safeguards.
                              {instructions}
                              </Prompt>
                              </Agent>
                              <Filepath="reports/instruction-review.md">
                              # Instruction review
                              {review}
                              </File>
                              The saved report:
                              <Filepath="reports/instruction-review.md" />

                              Run it with:

                              xmd run review-instructions.md --default-agent codex

                              Every structural step has operational meaning:

                              1. <Glob> deterministically selects the instruction files.
                              2. <Each> applies the same read procedure to every selected path.
                              3. <File> reads through the contextual filesystem capability.
                              4. <Prompt> is the one explicitly probabilistic judgment step and the one step that spends model tokens.
                              5. The write form of <File> atomically saves the review at a declared path.
                              6. The read form renders the saved artifact back into the document.

                              The example demonstrates the product thesis: documentation is the program, deterministic orchestration is not delegated to the model, and probabilistic behavior is visible exactly where it occurs.

                              This example uses currently shipped document constructs. Describe it under xmd run without claiming interruption recovery or Workspace reattachment. Confirm the final invocation syntax against the current coding-agent documentation when implementing the page.

                              The page may present the example as a four-part visual:

                              Discover → Read repeatedly → Apply judgment → Save the result
                              <Glob> <Each> + <File> <Prompt> <File>
                              deterministic deterministic model tokens deterministic
                              

                              Future durable example: publish only with its owning features

                              Once the exact Workspace, repository, Git, and GitHub components ship, evolve the example from a report into a workflow that can safely act on its result. Every listed step must remain programmatic rather than reverting to a prose checklist:

                              # Update repository instructions
                              <Workspace>
                              <Worktree>
                              <Branchname="docs/instruction-review" />
                              <Glob include={["**/AGENTS.md"]} as="instructionPaths" />
                              <Agent>
                              <Promptas="changes">
                              Resolve contradictions in these repository instructions:
                              <Eachin={instructionPaths}let="path">
                              ## {path}
                              <Filepath={path} />
                              </Each>
                              </Prompt>
                              </Agent>
                              <Filepath="reports/instruction-review.md">{changes}</File>
                              <Commit
                              paths={["reports/instruction-review.md"]}
                              message="Document instruction review"
                              as="commit"
                              />
                              <PullRequest
                              commit={commit}
                              title="Document instruction review"
                              />
                              </Worktree>
                              </Workspace>

                              This is a conceptual content example, not a syntax decision. Before publishing it, replace it with the exact shipped contracts from #218, #293, #294, #295, and related issues. In particular, do not assume that <Branch>, <Commit>, <PullRequest>, or their props have the shapes sketched here.

                              The accompanying explanation should emphasize:

                              • the model performs the judgment and content-generation step, not filesystem or Git orchestration;
                              • known environmental effects are declarative and visible in the document;
                              • the constrained workflow host authorizes filesystem, repository, Git, and GitHub capabilities;
                              • completed durable effects are restored or reconciled rather than blindly repeated;
                              • an interrupted execution reattaches to the same retained Workspace and continues at the journal frontier; and
                              • an unsupported imperative operation fails instead of escaping to the host.

                              Do not imply arbitrary journal-prefix rewind, exactly-once external side effects, recovery from deleted Workspace state, or arbitrary native command support.

                              Execution-mode comparison

                              Add this comparison only as each row becomes shipped and documented:

                              xmd runxmd workflow
                              EnvironmentCurrent host environmentRetained provider-backed Workspace
                              Best forRunning and experimenting with executable documentsProcedures that must continue across executions
                              OperationsHost capabilities, including supported executable blocksExplicit declarative capabilities plus supported constrained execution
                              JournalOptional diagnostic trace; never replayedDurable record used to restore completed effects and continue
                              InterruptionNo XMD environment-restoration guaranteeReattaches the same Workspace and resumes at the recorded frontier
                              Unsupported behaviorOrdinary host/runtime errorExplicitly rejected; never silently falls back to the host

                              The distinction is restoration, not basic correctness. A successful xmd run file write still completes correctly; XMD simply does not promise that another execution can reconstruct or reattach its environment.

                              Secondary use-case cards

                              After the primary example, show no more than three concise applications:

                              1. Release and repository procedures — files, branches, commits, pull requests, tests, and review steps expressed as one readable process.
                              2. Repeatable AI-assisted work — deterministic structure around visible probabilistic steps such as agents and sampling, with inputs and outputs named in the document.
                              3. Operational runbooks — documentation that can collect input, branch, retry, and eventually suspend or continue when those contracts ship.

                              Keep the existing multi-model provider demo as a deeper example or docs link. It demonstrates composition, but it should not define the product category from the hero because Executable.md is broader than LLM orchestration.

                              Current and future capability guardrail

                              Safe to demonstrate now: Markdown components, frontmatter metadata, typed props, content slots, <File>, <Glob>, <TempDir>, current control flow, executable fences, provider composition, coding-agent components, and diagnostic journals—using their current documented limitations.

                              Do not present as available until shipped:xmd workflow, provider-backed <Workspace>, restoration from a replay journal, <Branch>, <Commit>, <PullRequest>, durable suspension, and any declarative operation still marked unbuilt.

                              When a future capability is needed to explain direction before it ships, label it explicitly as product direction and keep it out of installation or getting-started paths.

                              Claims to avoid

                              • “Any Markdown becomes durable.”
                              • “Commands run exactly once.”
                              • “Workflows can run any native tool.”
                              • “Agents are deterministic.”
                              • “The diagnostic journal resumes a run.”
                              • “A Workspace can rewind to any journal entry.”
                              • “Reliable” without naming the implemented guarantee.

                              Prefer concrete language: the component validates its input; the file replacement is atomic; the journal restores a completed effect; the workflow reattaches the same Workspace; the unsupported operation fails explicitly.

                              Website changes

                              Homepage

                              • Replace the hero heading “Markdown that runs.” with “Turn documentation into repeatable workflows.”
                              • Rewrite the supporting paragraph around readable documentation, composable workflow components, and repeatable execution. Lead with the outcome; move runtime machinery such as executable fences and Effection lower on the page.
                              • Preserve the early/experimental disclosure.
                              • Reorder the page into a comprehension path: documented procedure → reusable components → execution modes → reliability/resumption → concrete example → installation.
                              • Retain “Still just markdown,” but connect readability to maintaining and reviewing the procedure rather than focusing first on fence-parser behavior.
                              • Replace the current feature inventory with benefits grouped around documentation, composition, execution, and observability/recovery. Keep links to detailed mechanics in the docs.
                              • Use an example that begins as an understandable procedure and demonstrates reuse or declarative intent. Avoid presenting an arbitrary shell block as the defining workflow abstraction.
                              • Explain xmd run and xmd workflow side by side once both are available, including their different environment and continuation guarantees.
                              • Reframe journals according to their shipped behavior. Diagnostic journals for xmd run must not be described as replayable; durable workflow continuation must be tied to the workflow journal and retained Workspace that actually implement it.
                              • Keep installation and GitHub/docs calls to action easy to find.

                              Metadata and navigation

                              • Update the homepage title, description, Open Graph, and Twitter copy in site/routes/_app.tsx to use the new positioning.
                              • Review navigation labels and anchors so the path through the page matches the new narrative rather than a flat “Features / Example” inventory.
                              • Keep terminology consistent between the homepage, docs landing page, CLI reference, and README where they make the same product-level claim.

                              Documentation entry points

                              • Update the docs landing page to introduce the distinction between running a document and running a durable workflow.
                              • Link each reliability claim to documentation for the concrete contract: journal behavior, Workspace retention, replay/resumption, unsupported operations, and provider boundaries.
                              • Make it explicit that ordinary operation correctness still applies to xmd run; “not durable” means there is no XMD guarantee of environment restoration or reattachment.

                              Truthfulness and sequencing

                              The website describes shipped behavior in the present tense. Do not publish xmd workflow, retained Workspace, replay, declarative Git/filesystem components, or other durability behavior as available before their implementations land.

                              Implement the content in two truthful layers if necessary:

                              1. Publish the tagline and outcome-oriented framing using capabilities that exist today.
                              2. Add the execution-mode and durability sections as their owning issues ship.

                              Do not use “reliable” as an unsupported general guarantee. Connect it to named contracts such as deterministic component execution, committed Workspace state, reattachment, or continuation.

                              Acceptance

                              • The homepage uses “Turn documentation into repeatable workflows.” as its primary headline.
                              • The first screen explains the user outcome without requiring knowledge of MDX, Effection, modifier chains, or runtime internals.
                              • The primary example is an executable procedure whose steps discover, read, decide, or write; it is not a prose checklist presented as a workflow.
                              • The page explains that executable workflows move deterministic work from repeated inference into direct execution.
                              • Token-cost copy says that explicit model-driven judgment still incurs per-run inference; it never promises that every workflow pays for tokens only once.
                              • No numeric savings claim appears without a reproducible representative benchmark.
                              • The page presents readable documentation and reusable composition as the path to repeatable execution.
                              • Shipped xmd run behavior and future or shipped xmd workflow behavior are never conflated.
                              • Every reliability or resumption claim corresponds to implemented behavior and links to its documentation.
                              • Unsupported workflow operations are described as explicit failures, not transparent host fallbacks.
                              • Homepage metadata and social copy use the same positioning.
                              • The docs landing page and relevant CLI reference use consistent run and workflow language.
                              • Existing installation instructions, examples, links, responsive behavior, theme behavior, and accessibility remain intact.
                              • The site build and repository verification gates pass.

                              Related work

                              Activity

                              Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

                              Metadata

                              Metadata

                              Assignees

                              No one assigned

                                Labels

                                No labels
                                No labels

                                Projects

                                No projects

                                  Milestone

                                  No milestone

                                  Relationships

                                  None yet

                                  Development

                                  No branches or pull requests

                                  Issue actions