docs: add index README and YAML frontmatter to every doc#3
Merged
Conversation
Add docs/README.md indexing every document in docs/ with a shared TYPE/CONNECTION vocabulary used consistently across all m-dev-tools repos. Add YAML frontmatter (created, last_modified, revisions, doc_type) to every existing doc. Existing frontmatter is merged, not replaced. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Ships the machine-readable m-cli <-> m-test-engine contract decided in docs/m-engine-implementation-plan.md so m-cli's `m doctor` and the upcoming `m engine` subcommand family have a single, version-handshaked surface to read from. * dist/m-test-engine.json — protocol 1, GHCR image ref, bind_mount object (host=/m-work, container=/m-work, mode=rw), compose-first + run_args fallback per plan §1.3 * dist/m-test-engine.schema.json — JSON Schema 2020-12, additive-only * tools/check-manifest.py — extended to validate both manifests: schema-shape, compose_file resolves on disk, verified_on within 90d * dist/repo.meta.json — enrolled engine_contract in exposes; bumped verified_on to 2026-05-11 * README.md — new "Machine-readable contract" section pointing consumers at the manifest + schema + drift gate * docs/m-engine-tracker.md — live progress tracker; locks the plan doc once stages move off `todo` Notes / followups recorded in tracker narrative log: - /m-work declared in manifest is target state; compose.yml and Dockerfile still bind /work — runtime cutover deferred to Phase 2 - ghcr.io image not yet published; Phase 3 covers the publish workflow Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 1a's manifest declared the canonical bind mount as /m-work but
left compose.yml + Dockerfile + lifecycle.json pinned to /work. This
commit closes that drift so a `docker compose up -d` produces a
container whose runtime layout matches the published contract.
* docker/compose.yml — bind ${M_TEST_ENGINE_BIND:-/m-work}:/m-work;
working_dir: /m-work; restart: unless-stopped (matches manifest
run_args.restart)
* docker/Dockerfile — WORKDIR /m-work; prose updated for the shared-
mount model
* dist/lifecycle.json — mount_point /m-work, mount_source_default
/m-work
* dist/repo.meta.json — notes field references the new mount point
* AGENTS.md + README.md — prose reflects the host /m-work shared
working tree (all m-* repos as siblings under one host directory,
visible identically inside the container)
This is the runtime half of the bind-mount decision in
docs/m-engine-implementation-plan.md §1.4. The m-cli side
(DockerEngine.bind_root default + stage_routines prefix-mapping) lands
in a coordinated m-cli commit.
`make check-manifest` green; `docker compose config` validates the
compose file shape. Smoke target requires a running container (kicked
off via `m engine start` once the m-cli side lands).
Tracker (docs/m-engine-tracker.md) updated with completed Phase 2
stages 2.0 (this cutover) + 2.1/2.2/2.3/2.5/2.6 on the m-cli side
and three new followups (sudo-in-fix design, capabilities recursion,
m_cli.engine package conversion).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/README.mdindexing every document indocs/with the shared TYPE/CONNECTION vocabulary established across the m-dev-tools org on 2026-05-11.created,last_modified,revisions,doc_type) to every existing doc indocs/. Existing frontmatter is merged, not replaced.m-dev-tools/.githubatdocs/docs-discoverability/README.md(committed via #35).Test plan
make check-docs-prosegate passes (docs/ is still prose-only).docs/README.mdlists every doc; labels use the agreed 23-type vocabulary.module:/synopsis:/errors:/conformance:/ etc. fields).🤖 Generated with Claude Code