markitect-tool/docs/examples-index.md

Examples Index

This index maps example files to practical usecases and useful commands.

Contracts And Diagnostics

Files	Usecase	Try
examples/contracts/adr.contract.md, examples/documents/adr-valid.md	ADR contract validation	mkt contract check examples/documents/adr-valid.md --contract examples/contracts/adr.contract.md
examples/contracts/business-letter.contract.md, examples/documents/business-letter-valid.md	Form-like business document validation	mkt contract form-state examples/documents/business-letter-valid.md --contract examples/contracts/business-letter.contract.md --context examples/runtime/business-letter.context.yaml
examples/contracts/prd-frs.contract.md, examples/documents/prd-frs-valid.md	Larger product/specification contract	mkt contract check examples/documents/prd-frs-valid.md --contract examples/contracts/prd-frs.contract.md
examples/diagnostics/*.expected-diagnostics.md	Expected failure explanations	Compare with mkt contract check ... --format text

Query, References, And Processors

Files	Usecase	Try
examples/references/context.md	Namespace, region, fence, and section references	mkt ref resolve examples/references/context.md 'std:clauses.md#payment-terms' --root examples/references
examples/references/standard/clauses.md	Referenced reusable content	Use with mkt ref resolve or mkt process
examples/migration/legacy-path-include.md	Migration-style include handling	mkt include examples/migration/legacy-path-include.md --base-dir examples/migration
examples/functions/basic-functions.md, examples/functions/typed-values.md	Deterministic document functions and typed value examples	mkt function render examples/functions/basic-functions.md

Templates, Generation, And Workflows

Files	Usecase	Try
examples/templates/adr-summary.template.md, examples/templates/adr-summary.data.yaml	Data-bound Markdown template	mkt template render examples/templates/adr-summary.template.md --data examples/templates/adr-summary.data.yaml
examples/templates/adr-summary.generation.md	Rule-based generation plan	mkt generate rules examples/templates/adr-summary.generation.md --output-dir /tmp/markitect-generated
examples/workflows/source-snippets.workflow.md	Extract snippets from Markdown sources	mkt workflow plan examples/workflows/source-snippets.workflow.md --output-dir /tmp/markitect-workflow
examples/workflows/adr-release-notes.workflow.md	ADR release notes workflow	mkt workflow plan examples/workflows/adr-release-notes.workflow.md --output-dir /tmp/markitect-workflow
examples/workflows/assisted-review.workflow.md	Assisted-generation boundary shape	Inspect with mkt workflow inspect

Source Adapter Contract Fixtures

Files	Usecase	Try
examples/source-adapters/*.json, examples/source-adapters/normalized-output.md	Expected envelopes for the v1 source adapter contract	Use as fixtures for mkt source commands after MKTT-WP-0018 implementation
examples/source-adapters/fake-adapter-pyproject.toml	External adapter entry point shape	Use as the fake package discovery fixture for source adapter contract tests

Render Export Contract Fixtures

Files	Usecase	Try
examples/render/fake-render-request.yaml	Deterministic render/export contract fixture	Use with the render.fake API adapter; no external renderer required
examples/render/render-reference-manifest.yaml	Render unit, cross-reference, TOC, asset, and source-map manifest fixture	Load with RenderReferenceManifest.from_dict; no renderer or asset copying required

Cache, Backend, Policy, And Context

Files	Usecase	Try
examples/backends/local-sqlite-backend.md	Backend manifest inspection	mkt backend inspect local-sqlite --path examples/backends/local-sqlite-backend.md
examples/backend-state/snapshot-state.yaml	Refresh planning fixture	mkt backend refresh-plan examples/documents --state examples/backend-state/snapshot-state.yaml --root .
examples/policy/local-label-policy.yaml	Local policy gateway	mkt policy check public-agent read note --policy examples/policy/local-label-policy.yaml --label public
examples/policy/enterprise-policy-map.yaml	Enterprise IAM mapping fixture	mkt policy subject examples/policy/netkingdom-claims.yaml --policy-map examples/policy/enterprise-policy-map.yaml
examples/memory/workplan-context.manifest.yaml	Context package manifest	mkt context pack examples/memory/workplan-context.manifest.yaml --root . --no-save
examples/memory/memory-profile.local.yaml, examples/memory/*graph*.yaml, examples/memory/*path*.yaml, examples/memory/*neighborhood*.yaml	Memory graph/profile contract fixtures	mkt memory graph pack examples/memory/decision-graph-selection.yaml --format yaml
examples/memory/invalid-memory-*.yaml, examples/memory/runtime-adapter-boundaries.yaml	Negative memory fixtures and runtime handoff descriptors	mkt memory graph validate examples/memory/invalid-memory-graph.yaml --format text

Literate And Migration

Files	Usecase	Try
examples/literate/app.md	Weave/tangle style code/document workflow	mkt tangle examples/literate/app.md --output-dir /tmp/markitect-tangle
examples/migration/legacy-explode-source.md	Reversible section splitting	mkt explode examples/migration/legacy-explode-source.md --output-dir /tmp/markitect-parts
examples/migration/legacy-literate.md	Legacy literate migration sample	mkt weave examples/migration/legacy-literate.md
examples/classes/prd-classes.yaml	Content class composition	mkt class resolve examples/classes/prd-classes.yaml product-prd