Skip to content

PRODUCT.md

Latest commit

 

History

History
56 lines (34 loc) · 3.37 KB

PRODUCT.md

File metadata and controls

56 lines (34 loc) · 3.37 KB
Raw

Product

Platform

web

Stack

Delegated: static HTML/CSS with small browser scripts, TypeScript, Bun tooling, Node.js runtime. The user authorized proceeding after the recommended stack, editorial reader, and direct implementation were presented. No frontend framework is needed for portable documentation.

Users

Repository owners and AI agents author documentation through files. Readers need to find a topic, understand it, follow examples, and move between related pages. Agents need portable Markdown access to the same content.

Product Purpose

MDD turns a repository's mdd/ folder into a rendered documentation website that its owner can host. The separate published mdd-engine package owns compilation; this application owns the reader, static output, and server. MDD is a renderer and server with no standalone CLI interface.

MDD's hosted delivery target is a Railway template. Only MDD Engine is a registry package; MDD consumes it as a dependency and does not need npm publication or Trusted Publishing. The template deploys the MDD application and accepts a separate content repository URL. See the delivery contract.

Operating Context

Authors edit Markdown, configuration, and selected theme files in Git. Static output can be served from GitHub Pages under a chosen prefix. The local reader, exporter, and Node server are implemented. The Railway template and external content-fetch integration remain planned, with one public content repository per deployment. There is no dashboard or database.

Capabilities and Constraints

  • File-derived navigation, article content, heading links, table of contents, previous/next pages, and a real not-found page.
  • Reading and navigation work without JavaScript. Enhancements must not require a hosted service.
  • Themes use CSS and optional browser JavaScript; author code never runs during compilation.
  • The server builds the configured documentation project and serves the rendered reader. The build API supports static exports with normalized Markdown and a search index.
  • Separate repositories, published engine dependency, Bun tools, Node 22/24/26 support with latest LTS default.
  • Private content repositories, plugins, accounts, search services, AI chat, and multiple sites are deferred.

Brand Commitments

The product is named mdd (Markdown Docs). Its voice is direct and useful. The approved “Page space” lowercase wordmark and blurple (#5865F2) identity are documented in brand/README.md. MDD’s own example uses this logo through its selected theme; documentation owners retain their configured site title and can supply their own theme.

Evidence on Hand

The published engine package and its documented API are available. Example documentation will describe actual local capabilities and will not claim deployment or publication before verification.

Product Principles

  • Author with ordinary files; keep hosting under the owner's control.
  • Compile once into portable output.
  • Keep the engine headless and reuse its output without duplicating its parser.
  • Prefer native browser and Node features to extra runtime dependencies.

Accessibility & Inclusion

Semantic HTML, visible keyboard focus, responsive reading, reduced-motion support, sufficient contrast, and functional navigation without JavaScript are implementation acceptance criteria.