From fc36e9a043b8f73ae46d99626c6a450bb9a6164a Mon Sep 17 00:00:00 2001 From: tegwick Date: Mon, 6 Jul 2026 19:41:37 +0200 Subject: [PATCH] Draft capability entry (reuse-surface REUSE-WP-0017-T04, cohort 2) Honest first-pass maturity vector grounded in README/docs/tests present in this repo; no invented evidence. Flagged for human review before publish. See reuse-surface history/2026-07-06-coverage-classification.md. Co-Authored-By: Claude Sonnet 5 --- ...ability.communication.markitect-toolkit.md | 130 ++++++++++++++++++ registry/indexes/capabilities.yaml | 21 ++- 2 files changed, 149 insertions(+), 2 deletions(-) create mode 100644 registry/capabilities/capability.communication.markitect-toolkit.md diff --git a/registry/capabilities/capability.communication.markitect-toolkit.md b/registry/capabilities/capability.communication.markitect-toolkit.md new file mode 100644 index 0000000..bdc172c --- /dev/null +++ b/registry/capabilities/capability.communication.markitect-toolkit.md @@ -0,0 +1,130 @@ +--- +id: capability.communication.markitect-toolkit +name: Markitect Markdown Toolkit And CLI +summary: Markdown-native toolkit and CLI (mkt) for turning semi-structured Markdown into structured, queryable, + reusable knowledge artifacts; syntax-layer successor to markitect-main. +owner: markitect-tool +status: draft +domain: communication +tags: +- markitect +- markdown +- cli +- toolkit +maturity: + discovery: + current: D4 + target: D5 + confidence: high + rationale: 'Extensive documentation set: INTENT.md, wiki/ProductRequirementsDocument.md, wiki/FunctionalRequirementsSpecification.md, + docs/getting-started.md, docs/cli-reference.md (generated), docs/api-reference.md (generated), docs/source-adapter-contract.md, + docs/source-adapter-migration.md, docs/performance-notes.md — an unusually complete documentation + set among the swept repos.' + availability: + current: A2 + target: A3 + confidence: high + rationale: Ships a documented CLI (`mkt`) and public API with generated reference docs; already consumed + by sibling adapter repos (markitect-filter for source adapters, markitect-quarkdown for render adapters) + via a versioned adapter contract. +external_evidence: + completeness: + level: C2 + confidence: low + basis: scope_vs_intent_and_consumer_expectations + satisfied_expectations: + - source-adapter contract with two implementing sibling repos (markitect-filter, markitect-quarkdown) + - generated CLI and API reference documentation + - documented migration path from markitect-main + broken_expectations: [] + out_of_scope_expectations: [] + reliability: + level: R1 + confidence: low + basis: consumer_quality_signals + known_reliability_risks: + - performance notes describe 'local performance posture' only — not independently load-tested in this + sweep +discovery: + intent: Turn semi-structured Markdown into structured, queryable, reusable knowledge artifacts via a + markdown-native CLI and API, as the syntax-layer successor to markitect-main. + includes: + - '`mkt` CLI' + - public API for structured Markdown artifacts + - versioned source/render adapter contracts (implemented by markitect-filter, markitect-quarkdown) + excludes: + - application-layer infospace lifecycle (see infospace-bench) + - knowledge-operations runtime (see kontextual-engine) + assumptions: [] + use_cases: [] + research_memos: [] +availability: + current_level: A2 + target_level: A3 + current_artifacts: + - '`mkt` CLI' + - Python package (`markitect-tool`) with generated API reference + target_artifacts: [] + consumption_modes: + - cli + - library import +relations: + depends_on: [] + supports: [] + related_to: [] +evidence: + documentation: + - INTENT.md + - wiki/ProductRequirementsDocument.md + - docs/cli-reference.md + - docs/api-reference.md + tests: + - tests/ + consumer_feedback: [] + bug_reports: [] + incidents: [] +consumer_guidance: + recommended_for: + - consumers needing markdown-native structured knowledge extraction and a stable CLI/API + not_recommended_for: + - needs for full infospace lifecycle management (see infospace-bench) or knowledge-operations runtime + (see kontextual-engine) + known_limitations: + - performance characterized only informally (local notes, not independently load-tested) +promotion_history: [] +--- + +# Markitect Markdown Toolkit And CLI + +## Overview + +`markitect-tool` is a markdown-native toolkit and CLI (`mkt`) that turns semi-structured Markdown into structured, queryable, reusable knowledge artifacts. It is the syntax-layer successor to `markitect-main`, with a versioned adapter contract already implemented by two sibling repos (`markitect-filter` for source adapters, `markitect-quarkdown` for render adapters). + +## Assessment notes + +### Discovery + +Extensive documentation set: INTENT.md, wiki/ProductRequirementsDocument.md, wiki/FunctionalRequirementsSpecification.md, docs/getting-started.md, docs/cli-reference.md (generated), docs/api-reference.md (generated), docs/source-adapter-contract.md, docs/source-adapter-migration.md, docs/performance-notes.md — an unusually complete documentation set among the swept repos. + +### Availability + +Ships a documented CLI (`mkt`) and public API with generated reference docs; already consumed by sibling adapter repos (markitect-filter for source adapters, markitect-quarkdown for render adapters) via a versioned adapter contract. + +### Completeness + +First-pass honest assessment from the REUSE-WP-0017 coverage campaign +(reuse-surface). No external consumer feedback exists yet; levels reflect +scope-vs-intent documentation quality, not internal code quality. + +### Reliability + +No production consumer telemetry exists yet; reliability level is +intentionally conservative pending REUSE-WP-0019 reuse-telemetry evidence. + +## Promotion checklist + +- [x] ID follows `capability..` pattern +- [x] Maturity enums match `specs/CapabilityMaturityStandard.md` +- [x] `external_evidence` is populated separately from `maturity` +- [ ] Relations reference valid capability IDs (none yet) +- [x] Index entry added in `registry/indexes/capabilities.yaml` diff --git a/registry/indexes/capabilities.yaml b/registry/indexes/capabilities.yaml index f944e47..27722a0 100644 --- a/registry/indexes/capabilities.yaml +++ b/registry/indexes/capabilities.yaml @@ -1,4 +1,21 @@ version: 1 -updated: '2026-06-16' +updated: '2026-07-06' domain: helix_forge -capabilities: [] +capabilities: +- id: capability.communication.markitect-toolkit + name: Markitect Markdown Toolkit And CLI + summary: Markdown-native toolkit and CLI (mkt) for turning semi-structured Markdown into structured, + queryable, reusable knowledge artifacts; syntax-layer successor to markitect-main. + vector: D4 / A2 / C2 / R1 + domain: communication + status: draft + owner: markitect-tool + path: registry/capabilities/capability.communication.markitect-toolkit.md + tags: + - markitect + - markdown + - cli + - toolkit + consumption_modes: + - cli + - library import