Back to Notes

Docs-as-code as simple as Google Docs

Docs-as-code sounds neat and tidy in theory, but not all docs are created equal. Strategy docs, onboarding guides, and customer research don't belong in code with API references, changelogs, and READMEs. Collaborative docs don't belong in a workflow built for engineers. But within an organization, it's often split: some people want to write docs in code, and some people want to write in a UI.

Docs in code vs docs in UI

Some docs changes are simple and instaneous, like updating a plan or adding some helpful context. You don't want to create a PR for that. Some changes are more involved, more fluid, and need to land alongside a corresponding stack of code changes. Those make sense in a PR. But if the docs live in the code or the UI exclusively, then discoverability becomes an issue. Both authoring use cases are valid, but easy discoverability is a non-negotiable for high-quality documentation. So we built the functionality to support both authoring options.

What we built

Our two-way GitHub sync binds a folder in Falconer to a repo path on GitHub. From there, the two sources stay in sync automatically: edits made in Falconer become commits in the repo, and commits made on GitHub sync back into Falconer.

For the non-technical user, the editor is the only surface they ever touch. No branches, PRs, or markdown linter to wrestle with. They get comments, real-time collaboration, suggestions, reviews, rich-text formatting, embedded images, and tables.

For engineers and agents, the canonical content still lives in the repo. PR review, code-owner approvals, version history, the whole git workflow they're familiar with. The commits Falconer creates look exactly like commits an engineer would have written: signed-off by the right author, attributed to the right person, gated by the same CODEOWNERS file that protects the rest of the repo.

There's no split-brain docs problem to navigate anymore. There's one document and one source of truth that people can edit in the UI or in the repo, and everything stays in sync. Now everyone can focus on writing how they please, and the discoverability from engineers, non-engineers, and agents is taken care of by Falconer.

Falconer app screenshot

Ready to get started?

Create an account and start building your knowledge base — no contracts or credit card required. Or, contact us to design a custom package for your team.