DEV Community

Max Bantsevich
Max Bantsevich

Posted on

We moved all our docs into Git. Then nobody outside the team could read them.

Over the last year, our agency quietly migrated all of its documentation into Git.
Only because of the tooling – once the team started living in Cursor and Claude Code, Markdown in a repo became the path of least resistance.

AI assistants reason over Markdown far better than over a 10-page Google Doc, edits are reviewable in a PR, and the docs sit next to the code they describe. This isn't a niche habit anymore: AGENTS.md and CLAUDE.md files now show up in 60k+ repositories. Docs-as-code is the norm.

And then we hit a wall we didn't see coming: the people who needed to read those docs couldn't.

We're not the only ones. You'll find the same complaint all over X — developers passing .md files around in Slack and Telegram while non-coding teammates can't even open them, let alone comment. As one put it: “I can't pass markdowns around the company.” That's every agency–client handoff right now.

Our clients aren't engineers. Neither are most PMs, designers, HR, or sales leads. So every handoff turned into the same dance: copy the Markdown into a Google Doc, update the repo a week later, re-export, re-paste, then hunt for the client's comments in a third place.
We looked at the obvious fixes, and each failed for a specific reason:

  • Invite them to GitHub/GitLab. A security review nobody wants, the repo has secrets, and the UI scares off non-coders. Asking a client to register on GitHub to read a spec is a non-starter.
  • GitBook. Wants you in its editor, and the pricing ($65/site + $12/user — ≈$173/mo for a 10-person team) made a lot of small teams quit it in 2025.
  • Mintlify. Pulls you out of your editor, and Pro runs $250–300/mo — too high for a small team.
  • Notion. Back to copy-pasting Markdown into another tool — and its MCP flatly blocks guest users, so a client's agent can't read anything.
  • Docusaurus / GitHub Wiki. A framework you build, deploy, and maintain — and comments require every commenter to have a GitHub login.

The pattern underneath all of them: they either move your docs somewhere new, or force your readers into developer tools. We wanted neither — just our existing repo, with a readable face and a comment box, for people who'll never open a terminal.

So we built it. It's called Miradorly (miradorly.com) — a viewer + comments layer over your existing GitHub/GitLab repo, free for 30 days, no card.

In the next post I'll walk through the architecture: how you render a repo as a live portal without changing how anyone writes, and how .docignore and per-project roles keep clients out of everything they shouldn't see.

Top comments (0)