hn.today

Markdown in /src

htmx.org18 points7 comments
Screenshot of Markdown in /src

The piece argues that Markdown is migrating from lightweight documentation into the actual source of truth for software systems as agentic coding (LLMs generating code) becomes common. It claims ephemeral prompt sessions leave intent scattered and generated code becomes the de facto ground truth, so teams should instead capture human-authored, diffable, and agent-readable Markdown alongside code in the repository. Markdown in /src would encode architectural, source-level, and data-design decisions at a level between formal specs and high-level design notes, making intent local to modules and accessible to both developers and agents.

Concretely, a proposed convention places module-focused Markdown under src/md with README, OVERVIEW, TODO, and subfolders for features, data models, APIs, and infrastructure. Tests remain automated checks derived from that Markdown rather than serving as the primary human-facing spec; developers are expected to edit both Markdown and generated code and synchronize changes. The recommendation emphasizes human curation of /src/md, minimal agent-authored content there, and treating Markdown as versioned, reviewable source that preserves intent, improves locality, and reduces reliance on distant wikis or ephemeral prompts.

Read on htmx.org7 comments on Hacker News

Summary generated by AI from the linked article. hn.today is not affiliated with Hacker News or Y Combinator.

More in Programming

The daily digest

Today's best Hacker News stories, summarized and screenshotted, one email a day.