markdown_workspace

markdown_workspace is a multi-package workspace for the MdWork client, native application shells, lander, reusable markdown packages, extension contracts, first-party extension packages, third-party extension distribution tooling, and repository operations.

Retained client-version delivery and PWA version-state behavior are documented in docs/client-version-delivery.md.

Table of Contents

• Repository Overview
• Repository Structure
• CI and Governance Conformance
• Documentation Pointers
• Community and Governance Files
• License

Repository Overview

This repository contains application shells, package workspaces, extension runtime and extension distribution tooling, conformance gates, and release automation.

The native shell layer deploys the client bundle as:

• Electron on Windows, macOS, and Linux
• Capacitor on Android

Repository Structure

• apps/ — deployable applications (client, lander)
• packages/ — contracts, renderer, editor, shared, and extension packages
• examples/ — runnable examples for editor/renderer integration
• docs/ — architecture, ADRs, conformance, current-state, and operations documentation
• specs/ — repository standards and policy specifications
• tools/ — CI, conformance, release, governance, and extension tooling
• artifacts/ — generated evidence and release artifacts

CI and Governance Conformance

Governance checks are enforced by CI and local scripts:

• tree validation
• doc-pointer validation
• root-clutter validation
• generated-artifact protection validation
• claim-language lint
• WIP-notes validation
• release-note validation

Run locally:

npm run ci:governance

Documentation Pointers

• Workspace docs index: docs/README.md
• Desktop shell reference: docs/apps/desktop-shell-app.md
• Repository specs index: specs/README.md
• Repository governance spec: specs/repository-governance-spec.md
• Agents guidance: AGENTS.md
• Contribution guide: CONTRIBUTING.md
• Code of conduct: CODE_OF_CONDUCT.md
• License text: LICENSE

Community and Governance Files

• AGENTS.md defines repository-specific operating constraints for automation agents.
• CONTRIBUTING.md documents contributor workflow and required checks.
• CODE_OF_CONDUCT.md defines behavior standards for participation.

License

Licensed under the Apache License, Version 2.0. See LICENSE.