FluentDocs: Keep Docs Accurate as Code Evolves

This is a submission for the DEV's Worldwide Show and Tell Challenge Presented by Mux

What I Built

FluentDocs is a documentation maintenance system that keeps your docs accurate as your code changes.

Its value is not in writing new documentation, but in eliminating the hidden cost of keeping documentation up to date. Instead of relying on memory, manual audits, or late CI warnings, FluentDocs continuously connects code changes to the documentation they affect.

With every git push, FluentDocs identifies which parts of your docs are impacted, explains why they are affected, and proposes precise, section-level updates. Writers and developers stay in control by reviewing, editing, or rejecting suggestions in a WYSIWYG editor, then shipping the result as a standard pull request.

My Pitch Video

stream.mux.com

Demo

Live Demo: https://www.fluentdocs.dev/

The Story Behind It

FluentDocs is actually an upgrade to an AI Agent I built called AutoDoc, which won me my first Dev.to challenge. Seeing its real-world value and potential, I decided to take it further and turn it into a fully fledged product.

The goal was clear: help developers and technical writers keep documentation accurate as code evolves, without adding more manual work to their workflow.

Building FluentDocs also reflects my broader ambition to move from building side projects to building businesses, and to explore entrepreneurship through solving real problems.

Technical Highlights

• Frontend & Backend: Next.js
• Editor: Tiptap (WYSIWYG) with a custom Markdown/Diff plugin.
• AI Agent: FastAPI
• Authentication: NextAuth.js with GitHub provider.
• Database & Search: MongoDB Atlas with Vector Search for semantic documentation mapping.
• Infrastructure & Tooling:
  • GitHub API: Octokit for repository interaction and PR creation.
  • Real-time Updates: Server-Sent Events (SSE).

FluentDocs is unique because it shifts documentation from a reactive task to a proactive automated workflow. Key differentiators include:

• Event-Driven Automation: Unlike AI assistants that require manual prompts (e.g., Copilot), FluentDocs triggers automatically on every git push. It proactively identifies "documentation drift" before it becomes a technical debt.
• Semantic Context Mapping: It uses vector embeddings and search to understand the relationship between code logic and documentation chunks, ensuring suggestions are contextually relevant rather than just keyword-based.
• Specialized WYSIWYG Diffing: The custom Tiptap-based editor provides a unique visual interface for reviewing AI suggestions. It allows users to see rich-text diffs and accept changes without manually editing raw Markdown files.
• Cross-Repository Intelligence: It supports complex architectures where documentation lives in a separate repository from the source code, maintaining synchronization across distributed systems.
• Seamless PR Integration: By orchestrating the full lifecycle—from webhook ingestion to automated Pull Request creation via Octokit—it fits directly into existing CI/CD pipelines without requiring developers to change their tools.