‹ BackHN Continuity

Thread

Markdown in /src

154 points · 99 comments · perrygeo

  1. maarut · · focus · HN ↗
    In many apps I've built, every decision is stored in Markdown files under docs/. But documentation can become obsolete, even comments inside source files can.

    I assume src/ is treated as the source of truth. If we start placing Markdown documentation inside src/, outdated documentation can live alongside the actual source of truth, blurring the boundary between what the system actually does and what the documentation says it does.

    1. [deleted] · · focus · HN ↗

      [deleted]

    2. gantamk · · focus · HN ↗
      I'd go further: the problem isn't where the docs live, it's that nothing checks them against the code.

      Yes, proximity indeed helps. However, I feel its better to automate docs revision using skills and related instructions in claude.mf/agents.md

      I am building something in related problem, which is architecture visualisation

Open on Hacker News to reply ↗

Unofficial Hacker News client; not affiliated with Y Combinator.