Guide
Guides: sharing docs and docs-as-code
Practical guides on sharing markdown docs with clients, adding comments, and running docs-as-code.
8 articles
8 articles in this section.
How to add comments to markdown files (that clients can use)
Markdown has no built-in commenting. Here are the real ways to add comments to markdown docs — PR reviews, Giscus, Google Docs round-trips, or a viewer with per-section comments — and which works for non-technical clients.
GuideDocs-as-code for agencies: the complete 2026 guide
A practical guide to docs-as-code for software agencies — what it is, why it fits agency workflows, the toolchain, and how to solve the one gap it leaves: sharing git docs with non-technical clients.
GuideDocumentation tools for Cursor and Claude Code users
If you write docs in Cursor or Claude Code, you don't need a new editor — you need a way to share and serve them. Here are the documentation tools that fit an AI-IDE, git-based workflow in 2026.
GuideGitHub Pages for client docs: when it's enough — and where it breaks
GitHub Pages is the reflex answer for publishing repo docs. It's great for public documentation — but private access requires GitHub Enterprise Cloud, and there are no roles or comments. A practical decision guide.
GuideHow to give clients access to docs without a GitHub account
Your clients shouldn't need a GitHub account to read your documentation. Here's how to give non-technical clients access to docs that live in a repo — with email login, scoped permissions, and comments.
GuideHow to share documentation with non-technical stakeholders
Designers, PMs, HR, sales, and leadership need your docs but won't touch a repo. Here's how to share documentation with non-technical stakeholders — readable, current, and commentable without GitHub.
GuideHow to share markdown docs with clients (without giving them your repo)
A practical guide to sharing markdown documentation with non-technical clients — the options (PDF, Google Docs, GitHub, static sites, a viewer), their trade-offs, and the fastest setup that keeps your editor.
GuideHow to share private GitHub repo docs without giving repo access
You can share documentation from a private GitHub or GitLab repo without granting repo access — here are the options (collaborator invites, deploy a site, or a viewer overlay) and the safest one.