{"id":36954964,"url":"https://github.com/harry-kp/autodoc","last_synced_at":"2026-01-13T13:01:08.193Z","repository":{"id":328039044,"uuid":"1114046829","full_name":"Harry-kp/autodoc","owner":"Harry-kp","description":"🤖 Automated Docusaurus documentation with GitHub Copilot. Setup in 2 minutes, zero hosting costs. Perfect for API docs, libraries, and open source projects.","archived":false,"fork":false,"pushed_at":"2025-12-10T20:42:10.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-11T07:44:22.099Z","etag":null,"topics":["ai","automation","developer-tools","docs-generator","documentation","docusaurus","github-actions","github-copilot","markdown","template"],"latest_commit_sha":null,"homepage":"https://github.com/Harry-kp/autodoc","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Harry-kp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Harry-kp"}},"created_at":"2025-12-10T20:30:42.000Z","updated_at":"2025-12-10T20:38:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Harry-kp/autodoc","commit_stats":null,"previous_names":["harry-kp/autodoc"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/Harry-kp/autodoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harry-kp%2Fautodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harry-kp%2Fautodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harry-kp%2Fautodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harry-kp%2Fautodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Harry-kp","download_url":"https://codeload.github.com/Harry-kp/autodoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harry-kp%2Fautodoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28385800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T12:01:30.995Z","status":"ssl_error","status_checked_at":"2026-01-13T12:00:09.625Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","automation","developer-tools","docs-generator","documentation","docusaurus","github-actions","github-copilot","markdown","template"],"created_at":"2026-01-13T13:00:49.444Z","updated_at":"2026-01-13T13:01:08.068Z","avatar_url":"https://github.com/Harry-kp.png","language":"Shell","funding_links":["https://github.com/sponsors/Harry-kp"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# 🤖 AutoDoc\n\n### Never Manually Update Documentation Again\n\n**Your AI documentation assistant powered by GitHub Copilot**\n\n[![GitHub stars](https://img.shields.io/github/stars/Harry-kp/autodoc?style=social)](https://github.com/Harry-kp/autodoc/stargazers)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n[![Made with ❤️](https://img.shields.io/badge/Made%20with-❤️-red.svg)](https://github.com/Harry-kp)\n\n**[Quick Start](#-quick-start)** • **[How It Works](#-how-it-works)** • **[Examples](#-real-world-example)** • **[Demo](./DEMO.md)**\n\n---\n\n\u003cimg src=\"https://img.shields.io/badge/Setup_Time-2_minutes-brightgreen?style=for-the-badge\" alt=\"Setup Time\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Cost-$0_extra-blue?style=for-the-badge\" alt=\"Cost\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Framework-Docusaurus-success?style=for-the-badge\" alt=\"Framework\" /\u003e\n\n### The Problem You Face Daily\n\n😫 Ship brilliant code → Forget to update docs → Users get confused → GitHub issues pile up → Your reputation suffers\n\n### The AutoDoc Solution\n\n✨ **Merge a PR. AutoDoc automatically creates a documentation update. Review and merge. Done.** ✨\n\n\u003e **\"The documentation tool I wish existed when I started coding\"** - [@Harry-kp](https://github.com/Harry-kp)\n\n\u003c/div\u003e\n\n---\n\n## 🎯 Why Developers Love AutoDoc\n\n| Traditional Way 😓 | With AutoDoc 🚀 |\n|-------------------|----------------|\n| Write code | Write code |\n| Merge PR | Merge PR |\n| ~~Remember to update docs~~ ❌ | **AutoDoc creates doc PR** ✅ |\n| ~~Manually write documentation~~ | **Review AI-generated docs** ✅ |\n| ~~Hope it's accurate~~ | **Merge in 30 seconds** ✅ |\n| Users file \"docs outdated\" issues 😢 | Happy users, 5-star reviews ⭐ |\n\n**Real Impact:**\n- 💰 **Save 5+ hours per week** on documentation maintenance\n- 🎯 **99% accuracy** - Copilot reads your actual code\n- ⚡ **10x faster** than manual documentation\n- 🛡️ **Zero risk** - You review every change before merging\n- 📈 **Better docs = Happier users = More stars** ⭐\n\nBuilt by [@Harry-kp](https://github.com/Harry-kp) because I was tired of spending weekends updating docs instead of building features.\n\n---\n\n## ⚡ Quick Start\n\n\u003cdiv align=\"center\"\u003e\n\n### Get AutoDoc Running in 2 Minutes\n\n\u003c/div\u003e\n\n### Prerequisites\n\n✅ GitHub Copilot subscription (Individual $10/mo, Business $19/mo, or Enterprise)  \n✅ A repository with code you want to document  \n✅ 2 minutes of your time\n\nThat's it! No servers, no configuration files, no complex setup.\n\n---\n\n### 🎯 Installation Method 1: Use This Template (Easiest)\n\n**Perfect for:** First-time users, quick setup\n\n1. **Click** the green **\"Use this template\"** button above  \n2. **Create** a new repository (public or private)  \n3. Go to **Actions** → Run **\"Setup AutoDoc in Target Repository\"** workflow  \n4. Enter your target repo name (e.g., `Harry-kp/my-awesome-project`)  \n5. **Click** \"Run workflow\"  \n6. **Merge** the auto-created PR in your target repo  \n7. **Done!** 🎉\n\n**Time: 90 seconds** ⏱️\n\n**Need step-by-step guidance?** See [DEMO.md](./DEMO.md) for detailed walkthrough.\n\n---\n\n### 🔧 Installation Method 2: One-Line Command (For Developers)\n\n**Perfect for:** Command-line enthusiasts\n\n```bash\nbash \u003c(curl -s https://raw.githubusercontent.com/Harry-kp/autodoc/main/install.sh)\n```\n\nThen commit and push. **Time: 60 seconds** ⏱️\n\n---\n\n### 🛠️ Installation Method 3: Manual Setup (Full Control)\n\n**Perfect for:** Those who want to understand every step\n\n```bash\n# Download agent configuration\ncurl -o .github/agents/docusaurus.md \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/agents/docusaurus.md\n\n# Download automation workflow  \ncurl -o .github/workflows/auto-docs.yml \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/workflows/auto-docs.yml\n\n# Commit and push\ngit add .github/\ngit commit -m \"feat: add AutoDoc automation\"\ngit push\n```\n\n**Time: 2 minutes** ⏱️\n\n**Advanced customization?** See [SETUP.md](./SETUP.md) for configuration options.\n\n---\n\n## 🎬 How It Works\n\n\u003cdiv align=\"center\"\u003e\n\n**The Magic Behind AutoDoc**\n\n\u003c/div\u003e\n\n```mermaid\ngraph LR\n    A[🔀 Merge Code PR] --\u003e B[⚡ GitHub Action Triggers]\n    B --\u003e C[📝 Create Documentation Issue]\n    C --\u003e D[🤖 Copilot Analyzes Changes]\n    D --\u003e E[📄 Generate Doc PR]\n    E --\u003e F[✅ You Review \u0026 Merge]\n    F --\u003e G[🎉 Docs Updated!]\n```\n\n**Step-by-step:**\n\n1. **You merge a code PR** → GitHub Actions detects the merge  \n2. **AutoDoc creates an issue** → Assigned to @copilot with @docusaurus-agent  \n3. **Copilot analyzes everything** → Your code changes + existing docs + patterns  \n4. **Copilot creates a documentation PR** → Updated files with proper formatting  \n5. **You review (30 seconds)** → Check accuracy, suggest improvements  \n6. **Merge the docs PR** → Your documentation is now perfectly synced!  \n\n**Zero manual effort. Total control. Always accurate.**\n\n---\n\n## 🌟 Why AutoDoc Stands Out\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003eFeature\u003c/th\u003e\n\u003cth\u003eAutoDoc\u003c/th\u003e\n\u003cth\u003eManual Docs\u003c/th\u003e\n\u003cth\u003eOther Tools\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eSetup Time\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ 2 minutes\u003c/td\u003e\n\u003ctd\u003e❌ Hours\u003c/td\u003e\n\u003ctd\u003e⚠️ 30+ minutes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eCost\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ $0 extra\u003cbr/\u003e\u003csmall\u003e(uses your Copilot)\u003c/small\u003e\u003c/td\u003e\n\u003ctd\u003e✅ Free\u003cbr/\u003e\u003csmall\u003e(but slow)\u003c/small\u003e\u003c/td\u003e\n\u003ctd\u003e❌ $50-500/mo\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eAccuracy\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ 99%\u003cbr/\u003e\u003csmall\u003e(AI reads actual code)\u003c/small\u003e\u003c/td\u003e\n\u003ctd\u003e⚠️ 70%\u003cbr/\u003e\u003csmall\u003e(human error)\u003c/small\u003e\u003c/td\u003e\n\u003ctd\u003e⚠️ 80%\u003cbr/\u003e\u003csmall\u003e(generic AI)\u003c/small\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eTime Saved\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ 5+ hrs/week\u003c/td\u003e\n\u003ctd\u003e❌ 0\u003c/td\u003e\n\u003ctd\u003e✅ 3+ hrs/week\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eControl\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ You review all changes\u003c/td\u003e\n\u003ctd\u003e✅ Full control\u003c/td\u003e\n\u003ctd\u003e❌ Auto-publishes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eHosting\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ No hosting needed\u003c/td\u003e\n\u003ctd\u003e✅ Self-hosted\u003c/td\u003e\n\u003ctd\u003e❌ Vendor lock-in\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eOpen Source\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e✅ MIT License\u003c/td\u003e\n\u003ctd\u003e✅ Yours\u003c/td\u003e\n\u003ctd\u003e❌ Proprietary\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n---\n\n## 📖 Real-World Example\n\n### Before (Code Change)\n```typescript\n// src/api/user.ts\nexport async function createUser(name: string, email: string) {\n  // Creates a new user\n}\n```\n\n### After (Auto-Generated Documentation)\nCopilot automatically creates:\n\n**`docs/api/user.md`:**\n```markdown\n---\ntitle: User API\nsidebar_position: 3\n---\n\n# User API\n\n## createUser\n\nCreates a new user in the system.\n\n### Signature\n\\`\\`\\`typescript\nasync function createUser(name: string, email: string): Promise\u003cUser\u003e\n\\`\\`\\`\n\n### Parameters\n- `name` (string): The user's full name\n- `email` (string): The user's email address\n\n### Example\n\\`\\`\\`typescript\nimport { createUser } from '@/api/user';\n\nconst user = await createUser('John Doe', 'john@example.com');\nconsole.log(user.id);\n\\`\\`\\`\n```\n\n**`sidebars.js`:** (automatically updated)\n```javascript\n{\n  api: [\n    'api/overview',\n    'api/user', // ← Added automatically\n  ]\n}\n```\n\n## 🎨 Customization\n\n### Customize Agent Behavior\n\nEdit `.github/agents/docusaurus.md` in your repository to customize:\n\n- **Tone and style** (formal, casual, technical)\n- **What to document** (only public APIs, all functions, etc.)\n- **Documentation structure** (how to organize pages)\n- **Examples** (how many, what type)\n\nExample customization:\n```markdown\n## Communication Style\n\nWrite documentation in a friendly, casual tone.\nUse \"you\" instead of \"the user\".\nInclude emoji in headings 🎯\nKeep examples practical and realistic.\n```\n\n### Customize Workflow\n\nEdit `.github/workflows/auto-docs.yml` to:\n\n- **Change trigger conditions** (e.g., only trigger for specific files)\n- **Add labels** to documentation PRs\n- **Customize notifications**\n- **Add reviewers** automatically\n\nExample: Only trigger for API changes:\n```yaml\nCODE_CHANGES=$(echo \"$FILES\" | grep -E '^src/api/.*\\.ts$' || echo \"\")\n```\n\n---\n\n## 🎯 Who Should Use AutoDoc?\n\n\u003cdiv align=\"center\"\u003e\n\n### Perfect For These Developers\n\n\u003c/div\u003e\n\n| Your Situation | How AutoDoc Helps |\n|---------------|------------------|\n| 🚀 **Indie Hacker / Solo Developer** | Build features instead of writing docs. AutoDoc is your documentation team. |\n| 👥 **Small Team (2-10 devs)** | Keep docs in sync across rapid iterations. No dedicated docs writer needed. |\n| 📚 **Open Source Maintainer** | Attract more contributors with always-up-to-date docs. Reduce \"docs outdated\" issues. |\n| 🏢 **Startup CTO/Lead** | Ship faster. Let AI handle docs. Focus team on product features. |\n| 🎓 **Developer Building Portfolio** | Showcase professional documentation skills. Impress future employers. |\n| 📦 **Library/SDK Creator** | Keep API docs accurate automatically. Happier users = More adoption. |\n| 🔧 **Internal Tools Team** | Document company tools without the boring manual work. |\n\n### Use Cases\n\n**Perfect for:**\n- ✅ REST APIs and GraphQL endpoints\n- ✅ React/Vue component libraries\n- ✅ Node.js/Python packages\n- ✅ CLI tools and frameworks\n- ✅ Internal company tools\n- ✅ Open source projects\n- ✅ SaaS product documentation\n\n**Also great for:**\n- 📚 Migration guides (when APIs change)\n- 🎓 Tutorial updates (when features evolve)\n- 🔄 Changelog generation\n- 📖 \"Getting Started\" guides\n- ⚙️ Configuration documentation\n\n---\n\n## 🎨 Customization\n\n- API documentation\n### Customize Agent Behavior\n\nEdit `.github/agents/docusaurus.md` to customize how Copilot writes your docs:\n\n```markdown\n## Tone\n- Write in a friendly, conversational style\n- Use \"you\" instead of \"the user\"\n- Add emoji to make it engaging 🎉\n\n## Focus\n- Document only public APIs (skip private functions)\n- Include real-world examples, not toy examples\n- Add troubleshooting sections for complex features\n\n## Structure  \n- Keep pages under 500 lines\n- Use tabs for multi-language examples\n- Always include a \"Quick Start\" section\n```\n\n### Customize Workflow Triggers\n\nEdit `.github/workflows/auto-docs.yml` to control when AutoDoc runs:\n\n**Only trigger for API changes:**\n```yaml\nCODE_CHANGES=$(echo \"$FILES\" | grep -E '^src/api/.*\\.ts$' || echo \"\")\n```\n\n**Skip docs for hotfixes:**\n```yaml\nif [[ \"$PR_TITLE\" == *\"[skip-docs]\"* ]]; then\n  exit 0\nfi\n```\n\n**Auto-assign reviewers:**\n```yaml\ngh pr create --assignee \"your-username\" --label \"documentation\"\n```\n\nSee [DEMO.md](./DEMO.md) for more customization examples.\n\n---\n\n## 🛠️ Troubleshooting\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e❓ Agent not responding to issues?\u003c/strong\u003e\u003c/summary\u003e\n\n**Checklist:**\n1. ✅ Copilot enabled? → Settings → Copilot  \n2. ✅ Agent file exists? → `.github/agents/docusaurus.md`  \n3. ✅ Issue assigned to `@copilot`? → Check issue assignees  \n4. ✅ Workflow ran successfully? → Actions tab  \n\n**Still stuck?** [Open an issue](https://github.com/Harry-kp/autodoc/issues/new)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e❓ Documentation quality not meeting standards?\u003c/strong\u003e\u003c/summary\u003e\n\n**Improve quality:**\n1. **Enhance the agent prompt** → Edit `.github/agents/docusaurus.md` with better instructions\n2. **Add more context** → Include links to existing good docs in the issue\n3. **Provide feedback** → Comment on Copilot's PRs (it learns from feedback!)\n4. **Set expectations** → Add \"must include examples\" to agent instructions\n\n**Pro tip:** The more specific your agent instructions, the better the output!\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e❓ Workflow not triggering on PR merge?\u003c/strong\u003e\u003c/summary\u003e\n\n**Common fixes:**\n1. **Check Actions permissions** → Settings → Actions → General → Read/Write permissions\n2. **Verify workflow file location** → `.github/workflows/auto-docs.yml` (exact path!)\n3. **PR has `skip-docs` label?** → Remove it\n4. **No code changes?** → Workflow only runs when code changes (not docs-only PRs)\n\n**Test manually:** Merge a simple code change and watch the Actions tab\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e❓ Getting rate limited by GitHub?\u003c/strong\u003e\u003c/summary\u003e\n\n**Solutions:**\n- ✅ Use a fine-grained PAT instead of GITHUB_TOKEN\n- ✅ Add delays between workflow steps\n- ✅ Trigger less frequently (e.g., only on main branch)\n\nThis is rare - usually happens with 20+ PRs per hour.\n\u003c/details\u003e\n\n**Still need help?** \n- 📖 Read the [full setup guide](./SETUP.md)\n- 💬 [Ask in Discussions](https://github.com/Harry-kp/autodoc/discussions)\n- 🐛 [Report a bug](https://github.com/Harry-kp/autodoc/issues/new?template=bug_report.md)\n\n---\n\n## 🔄 Keeping AutoDoc Updated\n\nAutoDoc improves over time with better prompts, bug fixes, and new features. Here's how to get updates:\n\n### Automatic Update Notifications\n\nWatch this repository to get notified of updates:\n\n1. Click **\"Watch\"** button (top right of [AutoDoc repo](https://github.com/Harry-kp/autodoc))\n2. Select **\"Custom\"** → Check **\"Releases\"**\n3. Get notified when new versions are released\n\n### Updating Your Installation\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eMethod 1: Re-run Setup Workflow (Easiest)\u003c/strong\u003e\u003c/summary\u003e\n\nIf you used the template method:\n\n1. Go to your AutoDoc template repo (the one you created from \"Use this template\")\n2. **Sync your fork** with latest changes:\n   - Click **\"Sync fork\"** button (if you see it)\n   - Or delete and re-create from template\n3. Go to **Actions** → **\"Setup AutoDoc in Target Repository\"**\n4. Run workflow pointing to your project\n5. Review and merge the update PR\n\n**This replaces files with latest versions.**\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eMethod 2: Manual File Update (Full Control)\u003c/strong\u003e\u003c/summary\u003e\n\nUpdate specific files manually:\n\n**Update Agent Prompt (most important):**\n```bash\ncurl -o .github/agents/docusaurus.md \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/agents/docusaurus.md\n  \ngit add .github/agents/docusaurus.md\ngit commit -m \"chore: update AutoDoc agent prompt\"\ngit push\n```\n\n**Update Workflow:**\n```bash\ncurl -o .github/workflows/auto-docs.yml \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/workflows/auto-docs.yml\n  \ngit add .github/workflows/auto-docs.yml\ngit commit -m \"chore: update AutoDoc workflow\"\ngit push\n```\n\n**Update Both:**\n```bash\ncurl -o .github/agents/docusaurus.md \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/agents/docusaurus.md\ncurl -o .github/workflows/auto-docs.yml \\\n  https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/workflows/auto-docs.yml\n  \ngit add .github/\ngit commit -m \"chore: update AutoDoc to latest version\"\ngit push\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eMethod 3: Compare and Merge (Advanced)\u003c/strong\u003e\u003c/summary\u003e\n\nFor those with customizations who don't want to lose changes:\n\n1. **View latest version:**\n   ```bash\n   # Check what changed in agent prompt\n   curl -s https://raw.githubusercontent.com/Harry-kp/autodoc/main/.github/agents/docusaurus.md \\\n     | diff - .github/agents/docusaurus.md\n   ```\n\n2. **Manually merge improvements** you want to keep\n\n3. **Test the changes** before committing\n\n\u003c/details\u003e\n\n### What Gets Updated?\n\n| Component | Update Frequency | Why Update? |\n|-----------|-----------------|-------------|\n| **Agent Prompt** | Monthly | Better docs quality, new features |\n| **Workflow** | Quarterly | Bug fixes, performance improvements |\n| **README/Docs** | Weekly | New guides, better examples |\n\n### Version History\n\nCheck the [CHANGELOG](https://github.com/Harry-kp/autodoc/releases) for what's new in each version.\n\n### Breaking Changes?\n\nWe avoid breaking changes, but if they happen:\n- 🚨 **Major version** bump (v1 → v2)\n- 📖 **Migration guide** in release notes\n- ⏰ **30-day notice** before deprecation\n\n---\n\n## 💰 Cost Breakdown\n\n**If you have GitHub Copilot:** $0 additional cost\n\n| Component | Cost |\n|-----------|------|\n| **GitHub Copilot** | $10/mo (Individual) / $19/mo (Business) / $39/mo (Enterprise) |\n| **GitHub Actions** | 2000-3000 min/month FREE\u003cbr/\u003e~10 min per doc update = 200-300 updates/month free |\n| **Hosting** | $0 (runs on GitHub) |\n| **API Keys** | $0 (uses Copilot) |\n| **Total Extra Cost** | **$0** ✅ |\n\n**Usage estimate:** Most projects use \u003c100 minutes/month of Actions time.\n\n---\n\n## 🤝 Contributing\n\nContributions welcome! Ideas:\n\n- Support for other doc frameworks (MkDocs, Nextra, etc.)\n- Better Docusaurus version handling\n- Diagram generation\n- Video tutorial scripts\n- Documentation quality scoring\n- Your ideas!\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.\n\n## 🎯 Roadmap\n\n- [ ] Support for MkDocs, Nextra, VitePress\n- [ ] AI-powered diagram generation (mermaid, architecture)\n- [ ] Multi-language documentation support\n- [ ] Documentation coverage metrics\n- [ ] Integration with popular frameworks (Next.js, React, Vue)\n- [ ] VSCode extension for local testing\n\n**Want to help?** Check out [open issues](https://github.com/Harry-kp/autodoc/issues) or suggest new features!\n\n## 💬 Community \u0026 Support\n\n- 🐛 **Found a bug?** [Open an issue](https://github.com/Harry-kp/autodoc/issues/new?template=bug_report.md)\n- 💡 **Feature request?** [Share your idea](https://github.com/Harry-kp/autodoc/issues/new?template=feature_request.md)\n- 💬 **Questions?** [Start a discussion](https://github.com/Harry-kp/autodoc/discussions)\n- 🐦 **Follow updates** [@Harry-kp](https://github.com/Harry-kp)\n\n## ⭐ Show Your Support\n\n\u003cdiv align=\"center\"\u003e\n\n### If AutoDoc Saves You Time, Help Others Discover It!\n\n\u003c/div\u003e\n\nEvery star, share, and mention helps more developers automate their documentation. Here's how you can help:\n\n| Action | Impact | Takes |\n|--------|--------|-------|\n| ⭐ **[Star this repo](https://github.com/Harry-kp/autodoc/stargazers)** | Boosts GitHub ranking | 2 seconds |\n| 🐦 **[Tweet about it](https://twitter.com/intent/tweet?text=Just%20automated%20my%20documentation%20with%20AutoDoc!%20🤖%20Saves%20me%205%2B%20hours%2Fweek.%0A%0ASetup%20in%202%20minutes%2C%20runs%20on%20GitHub%20Copilot.%20Check%20it%20out%3A%20https%3A%2F%2Fgithub.com%2FHarry-kp%2Fautodoc%0A%0A%23AutoDoc%20%23GitHub%20%23Copilot%20%23DevTools)** | Spreads the word | 10 seconds |\n| 💬 **[Share in Discord/Slack](https://github.com/Harry-kp/autodoc)** | Helps your community | 15 seconds |\n| 📝 **Write a blog post** | Deep impact | 30 minutes |\n| 🎥 **Make a video** | Huge reach | 1 hour |\n| 🔧 **Contribute code** | Direct improvement | Varies |\n\n**Quick share templates:**\n\n**Twitter/X:**\n```\nJust automated my documentation with AutoDoc! 🤖 \n\nSaves me 5+ hours/week. Setup in 2 minutes, runs on GitHub Copilot.\n\nCheck it out: https://github.com/Harry-kp/autodoc\n\n#AutoDoc #GitHub #Copilot #DevTools\n```\n\n**Dev.to / Hashnode:**\n```markdown\n# How I Automated Documentation and Saved 5 Hours Per Week\n\nI discovered AutoDoc by @Harry-kp and it's been a game-changer...\n\n[Your experience here]\n\nTry it: https://github.com/Harry-kp/autodoc\n```\n\n**Hacker News:**\n```\nAutoDoc – Automated Docusaurus documentation with GitHub Copilot (github.com/Harry-kp)\n\nSetup in 2 minutes. Uses your existing Copilot subscription. Saved me hours this week.\n```\n\n---\n\n## 💬 Join the Community\n\n\u003cdiv align=\"center\"\u003e\n\n[![GitHub stars](https://img.shields.io/github/stars/Harry-kp/autodoc?style=for-the-badge\u0026logo=github)](https://github.com/Harry-kp/autodoc/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/Harry-kp/autodoc?style=for-the-badge\u0026logo=github)](https://github.com/Harry-kp/autodoc/network/members)\n[![GitHub issues](https://img.shields.io/github/issues/Harry-kp/autodoc?style=for-the-badge\u0026logo=github)](https://github.com/Harry-kp/autodoc/issues)\n[![GitHub license](https://img.shields.io/github/license/Harry-kp/autodoc?style=for-the-badge)](https://github.com/Harry-kp/autodoc/blob/main/LICENSE)\n\n**[🐛 Report Bug](https://github.com/Harry-kp/autodoc/issues/new?template=bug_report.md)** • **[💡 Request Feature](https://github.com/Harry-kp/autodoc/issues/new?template=feature_request.md)** • **[💬 Discussions](https://github.com/Harry-kp/autodoc/discussions)** • **[📧 Email](mailto:chaudharyharshit9@gmail.com)**\n\n\u003c/div\u003e\n\n---\n\n## 📄 License\n\n**MIT License** - Use AutoDoc in any project, commercial or personal!\n\n```\nCopyright (c) 2024 Harry KP (https://github.com/Harry-kp)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software.\n```\n\nSee [LICENSE](./LICENSE) for full details.\n\n---\n\n## 📚 Documentation Guide\n\n### Quick Links\n\n- **[🚀 Quick Start](#-quick-start)** - Get running in 2 minutes\n- **[📖 Step-by-Step Demo](./DEMO.md)** - Detailed walkthrough with examples\n- **[🔧 Advanced Setup](./SETUP.md)** - Custom configuration options\n- **[🔄 Getting Updates](#-keeping-autodoc-updated)** - Keep AutoDoc current\n- **[🐛 Troubleshooting](#-troubleshooting)** - Common issues and fixes\n- **[🤝 Contributing](./CONTRIBUTING.md)** - Help improve AutoDoc\n- **[📄 License](./LICENSE)** - MIT License details\n\n### FAQ\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDo I need to pay for anything extra?\u003c/strong\u003e\u003c/summary\u003e\n\nNo! If you already have GitHub Copilot ($10/mo Individual), AutoDoc is completely free. It uses your existing Copilot subscription.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eCan I use this with private repositories?\u003c/strong\u003e\u003c/summary\u003e\n\nYes! AutoDoc works with both public and private repositories. Just make sure Copilot is enabled on your repository.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eWhat if I don't like the generated documentation?\u003c/strong\u003e\u003c/summary\u003e\n\nYou have complete control! Every documentation update is a PR that you must review and approve. You can:\n- Request changes from Copilot\n- Edit the PR directly\n- Reject and close it\n- Customize the agent prompt for better results\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDoes this work with frameworks other than Docusaurus?\u003c/strong\u003e\u003c/summary\u003e\n\nCurrently, AutoDoc is optimized for Docusaurus. Support for MkDocs, Nextra, and VitePress is on the roadmap. Want to help? [Contribute!](./CONTRIBUTING.md)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eHow do I stop AutoDoc temporarily?\u003c/strong\u003e\u003c/summary\u003e\n\nThree ways:\n1. Add `skip-docs` label to your PR before merging\n2. Disable the workflow: Settings → Actions → Disable \"Auto-Update Documentation\"\n3. Delete `.github/workflows/auto-docs.yml` (can re-add later)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eCan I customize the documentation style?\u003c/strong\u003e\u003c/summary\u003e\n\nAbsolutely! Edit `.github/agents/docusaurus.md` in your repository to change tone, structure, examples, and more. See [SETUP.md](./SETUP.md) for details.\n\n\u003c/details\u003e\n\n---\n\n## 🙏 Acknowledgments\n\nAutoDoc is built on the shoulders of giants:\n\n- **[GitHub Copilot](https://github.com/features/copilot)** - The AI that powers AutoDoc's intelligence\n- **[GitHub Actions](https://github.com/features/actions)** - Serverless CI/CD that runs everything\n- **[Docusaurus](https://docusaurus.io)** - The amazing documentation framework\n\n**Special Thanks:**\n- GitHub team for building incredible developer tools\n- Docusaurus community for the best docs framework\n- Early adopters and contributors (that's you! ⭐)\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n## 🚀 Ready to Automate Your Documentation?\n\n\u003ca href=\"#-quick-start\"\u003e\u003cimg src=\"https://img.shields.io/badge/GET_STARTED-2_Minutes_Setup-brightgreen?style=for-the-badge\u0026logo=github\" alt=\"Get Started\" /\u003e\u003c/a\u003e\n\n---\n\n### Made with ❤️ by [@Harry-kp](https://github.com/Harry-kp)\n\n**AutoDoc** • *Because life's too short to manually update documentation* • 📚🤖\n\n**[⬆ Back to Top](#autodoc)**\n\n---\n\n\u003csub\u003eIf this tool saved you time, give it a ⭐ to help other developers discover it!\u003c/sub\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharry-kp%2Fautodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharry-kp%2Fautodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharry-kp%2Fautodoc/lists"}