Docusync

🚀 Project Name DocuSync – Autonomous Documentation Agent Powered by Orkes

🧠 Inspiration Developers spend hours writing and maintaining documentation that often lags behind evolving code. Broken examples, outdated API specs, and unclear guides create technical debt and frustrate users. We envisioned DocuSync as a continuously running documentation agent—one that understands code changes, reacts to user confusion, and keeps everything in sync like a 24/7 documentation engineer.

🛠️ What It Does DocuSync is a multi-agent system that:

Monitors GitHub pull requests and code changes

Updates markdown docs and OpenAPI specs

Validates API examples and code snippets

Learns your team's doc style over time

Surfaces user feedback to clarify confusing sections

Posts doc previews to GitHub for review and approval

All agents are coordinated by Orkes (Temporal) and backed by a GitHub App, LLMs, Supabase, and Swagger tooling.

🧩 How We Built It 🔗 Agent Orchestration with Orkes Used Orkes (Temporal SaaS) to define a durable workflow:

Commit-Watcher Agent

Doc-Maintainer Agent

Style Agent

CI Validator Agent

GitHub Bot Agent

Feedback Clarifier Agent

Each agent runs independently and passes context to the next via Orkes task queues.

🧰 Tools & Tech Stack Layer Tech Auth & Storage Supabase (GitHub login, env vars, feedback logs) LLM/NLP OpenAI API for rephrasing and clarity generation Docs Parsing AST diffing + OpenAPI YAML parsing Swagger Validation dredd, spectral for endpoint & example testing Orchestration Orkes (Temporal Cloud) GitHub Integration GitHub App + REST API (webhooks, bot comments) Frontend React + Tailwind + Supabase Dashboard Deployment Vercel (frontend), Render (backend), Orkes Cloud

🎯 Key Features Doc-Aware GitHub App: Detects PR changes and starts agent workflows automatically.

Swagger Validator: Runs OpenAPI validation and tests example requests/responses.

Reader Feedback Trigger: Allows users to click “I’m confused” on doc sections, which triggers an LLM-based clarification.

Agent Previews: GitHub bot posts doc changes with markdown diffs for reviewer approval.

Supabase Dashboard: Review & approve doc updates, manage env variables for live snippet validation.

🌍 Real-World Use Cases API companies (Stripe-like) that need up-to-date SDK docs

Open source projects with complex or fast-changing code

Internal dev portals with microservice documentation

Compliance-heavy industries needing auditable doc change tracking

🧪 Challenges We Faced Coordinating multiple agents in a robust, observable way

Safely testing code examples requiring secrets (env var injection)

Creating a feedback loop from both code and users (PRs + “I’m confused” button)

Managing GitHub App authentication and PR comment APIs

✅ Accomplishments Fully orchestrated doc sync system using Orkes + GitHub

Deployed GitHub App that comments on PRs with intelligent doc suggestions

CI validation pipeline that runs code examples and OpenAPI tests

Real-time feedback capture with AI-powered clarification

📈 What’s Next Integration with LlamaIndex for vector search and semantic doc diffs

Doc-to-video walkthrough generation via AI agents

Feedback analytics dashboard with HockeyStack-style tracking

Support for i18n + multi-language doc syncing

🙌 Built With Help From 🧡 Orkes (Temporal) for workflow management

🔐 Supabase for GitHub auth and metadata storage

🤖 GitHub Apps for webhook and comment automation

📄 Gemini + dredd, spectral for doc validation

✨ Gemini for explanation generation

Accomplishments that we're proud of

What we learned

What's next for Docusync

Built With

• gemini
• llama
• orkes