From e1f0f2e4046575c25f412aa91cfd712803e435e8 Mon Sep 17 00:00:00 2001 From: johnxie Date: Mon, 13 Apr 2026 00:22:21 -0700 Subject: [PATCH] fix: remove internal planning files and IDE config from public repo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove .continue/prompts/ (Continue IDE config, not project content) - Remove ENHANCEMENT_PLAN.md (internal work planning doc) - Remove IMPORT_ROADMAP_TODO.md (stale roadmap, all items done) - Add .continue/, .vscode/, .idea/, .env to .gitignore - Update stale counts in CONTENT_GAPS_ANALYSIS.md (201→203) - Update stale counts in TUTORIAL_STRUCTURE.md (201→203) --- .continue/prompts/new-prompt.md | 7 -- .gitignore | 9 +++ CONTENT_GAPS_ANALYSIS.md | 4 +- ENHANCEMENT_PLAN.md | 104 ---------------------------- IMPORT_ROADMAP_TODO.md | 119 -------------------------------- TUTORIAL_STRUCTURE.md | 2 +- 6 files changed, 12 insertions(+), 233 deletions(-) delete mode 100644 .continue/prompts/new-prompt.md delete mode 100644 ENHANCEMENT_PLAN.md delete mode 100644 IMPORT_ROADMAP_TODO.md diff --git a/.continue/prompts/new-prompt.md b/.continue/prompts/new-prompt.md deleted file mode 100644 index 9fd5bf20..00000000 --- a/.continue/prompts/new-prompt.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: New prompt -description: New prompt -invokable: true ---- - -Please write a thorough suite of unit tests for this code, making sure to cover all relevant edge cases \ No newline at end of file diff --git a/.gitignore b/.gitignore index a0090b46..41089384 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,11 @@ # macOS .DS_Store + +# IDE / editor config +.continue/ +.vscode/ +.idea/ + +# Environment +.env +.env.* diff --git a/CONTENT_GAPS_ANALYSIS.md b/CONTENT_GAPS_ANALYSIS.md index e23e0297..6a8f6add 100644 --- a/CONTENT_GAPS_ANALYSIS.md +++ b/CONTENT_GAPS_ANALYSIS.md @@ -6,8 +6,8 @@ This document tracks structural and quality gaps that impact completeness and di | Metric | Value | |:-------|:------| -| Tutorial directories | 201 | -| Tutorials with exactly 8 numbered chapters | 198 | +| Tutorial directories | 203 | +| Tutorials with exactly 8 numbered chapters | 200 | | Tutorials with >8 numbered chapters | 3 | | Tutorials with 0 numbered chapters | 0 | | Tutorials with partial chapter coverage (1-7) | 0 | diff --git a/ENHANCEMENT_PLAN.md b/ENHANCEMENT_PLAN.md deleted file mode 100644 index 2b1f1950..00000000 --- a/ENHANCEMENT_PLAN.md +++ /dev/null @@ -1,104 +0,0 @@ -# Documentation Enhancement Plan - -## Current State Analysis - -Based on CONTENT_GAPS_ANALYSIS.md: -- 201 tutorials total -- 198 with exactly 8 chapters -- 3 with >8 chapters (n8n-mcp, langchain, ag2) -- 0 with 0 chapters -- 0 with partial chapter coverage - -## Enhancement Strategy - -### Phase 1: High-Traffic Tutorial Regeneration -**Priority**: Top 10 tutorials by stars from `discoverability/tutorial-source-verification.json` - -| Tutorial | Stars | Repo | Status | -|----------|-------|------|--------| -| openclaw/openclaw | 341,130 | openclaw/openclaw | Need regeneration | -| facebook/react | 244,271 | facebook/react | Need regeneration | -| n8n-io/n8n | 181,679 | n8n-io/n8n | Need regeneration | -| ollama/ollama | 166,451 | ollama/ollama | Need regeneration | -| huggingface/transformers | 158,545 | huggingface/transformers | Need regeneration | -| langflow-ai/langflow | 146,399 | langflow-ai/langflow | Need regeneration | -| langgenius/dify | 134,981 | langgenius/dify | Need regeneration | -| anomalyco/opencode | 132,650 | anomalyco/opencode | Need regeneration | -| langchain-ai/langchain | 131,599 | langchain-ai/langchain | Need regeneration | -| open-webui/open-webui | 129,246 | open-webui/open-webui | Need regeneration | - -### Phase 2: Missing High-Impact Tutorials -**Priority**: Add tutorials for trending OSS projects not yet covered - -**Candidates** (check GitHub for stars > 10K): -- Vercel AI SDK (22K+ stars) - Already covered -- Browser Use (85K+ stars) - Already covered -- Claude Code (84K+ stars) - Already covered -- Model Context Protocol servers (82K+ stars) - Already covered -- Infiniflow RAGFlow (76K+ stars) - Already covered -- vLLM (74K+ stars) - Already covered - -**New additions needed**: -- Check GitHub for trending repos in AI/agents space -- Focus on repos with recent activity (pushed_at in last 30 days) -- Target repos with documentation gaps - -### Phase 3: Content Gap Resolution -**Priority**: Fill missing code examples and depth - -**Issues to fix**: -1. Tutorials with <100 lines in chapters (already addressed in commit 5bda1be) -2. Missing Mermaid diagrams in architecture chapters -3. Inconsistent code example quality across tutorials -4. Missing production deployment examples - -### Phase 4: Source Code Extraction Improvements -**Priority**: Enhance the regeneration script - -**Improvements needed**: -1. Better file prioritization (focus on core modules) -2. Handle more file types (`.md`, `.json`, `.yaml`, `.toml`) -3. Better abstraction detection for different languages -4. Add test file extraction for usage examples -5. Better Mermaid diagram generation from code structure - -## Execution Plan - -### Step 1: Regenerate High-Traffic Tutorials -```bash -# Run regeneration on top 10 tutorials -python scripts/regenerate_tutorial_chapters.py \ - --slugs openclaw,facebook-react,n8n,ollama,huggingface-transformers,langflow,dify,opencode,langchain,open-webui -``` - -### Step 2: Add New Tutorials -1. Identify 5-10 missing high-impact repos -2. Create tutorial directories with proper structure -3. Add to `llms.txt` and `llms-full.txt` -4. Update `discoverability/tutorial-source-verification.json` - -### Step 3: Fix Content Gaps -1. Review tutorials with low chapter counts -2. Add missing code examples from source repos -3. Add Mermaid diagrams where missing -4. Ensure consistent production examples - -### Step 4: Improve Source Extraction -1. Update `regenerate_tutorial_chapters.py` -2. Add better file filtering logic -3. Enhance abstraction detection -4. Add diagram generation from code structure - -### Step 5: Quality Verification -```bash -# Run health checks -python scripts/docs_health.py -``` - -## Success Metrics - -- [ ] All top 10 tutorials have real code examples from source repos -- [ ] 5-10 new high-impact tutorials added -- [ ] 0 tutorials with placeholder content -- [ ] All tutorials pass docs_health.py checks -- [ ] Source extraction script handles 95%+ of file types diff --git a/IMPORT_ROADMAP_TODO.md b/IMPORT_ROADMAP_TODO.md deleted file mode 100644 index bb655618..00000000 --- a/IMPORT_ROADMAP_TODO.md +++ /dev/null @@ -1,119 +0,0 @@ -# Import Roadmap TODO (Vibe Coding + Agent Ecosystem) - -_Last updated: auto-maintained as packs merge_ - -This roadmap tracks the next highest-impact tutorial imports for `awesome-code-docs`, prioritized by ecosystem impact, recency, and strategic fit with AI coding agents, vibe coding, and MCP workflows. - -## P0 (Do First) - -| Repo | Stars | Priority | Pack | Status | -|:-----|------:|:---------|:-----|:-------| -| [`stitionai/devika`](https://github.com/stitionai/devika) | 19.5k+ | P0 | `pack-by` | done | -| [`yoheinakajima/babyagi`](https://github.com/yoheinakajima/babyagi) | 18k+ | P0 | `pack-by` | done | -| [`kirodotdev/Kiro`](https://github.com/kirodotdev/Kiro) | 1.8k+ (AWS) | P0 | `pack-by` | done | -| [`anomalyco/opencode`](https://github.com/anomalyco/opencode) | 102k+ | P0 | `pack-ae` | done | -| [`mastra-ai/mastra`](https://github.com/mastra-ai/mastra) | 21k+ | P0 | `pack-ae` | done | -| [`langflow-ai/langflow`](https://github.com/langflow-ai/langflow) | 144k+ | P0 | `pack-af` | done | -| [`agno-agi/agno`](https://github.com/agno-agi/agno) | 37k+ | P0 | `pack-af` | done | -| [`google-gemini/gemini-cli`](https://github.com/google-gemini/gemini-cli) | 94k+ | P0 | `pack-ba` | done | -| [`thedotmack/claude-mem`](https://github.com/thedotmack/claude-mem) | 27k+ | P0 | `pack-ba` | done | - -## P1 (High Impact) - -| Repo | Stars | Priority | Pack | Status | -|:-----|------:|:---------|:-----|:-------| -| [`GLips/Figma-Context-MCP`](https://github.com/GLips/Figma-Context-MCP) | 13k+ | P1 | `pack-ag` | done | -| [`humanlayer/humanlayer`](https://github.com/humanlayer/humanlayer) | 9k+ | P1 | `pack-ag` | done | -| [`The-Pocket/PocketFlow`](https://github.com/The-Pocket/PocketFlow) | 9k+ | P1 | `pack-ah` | done | -| [`plandex-ai/plandex`](https://github.com/plandex-ai/plandex) | 14k+ | P1 | `pack-ah` | done | -| [`block/goose`](https://github.com/block/goose) | 30k+ | P1 | `pack-ap` | done | -| [`charmbracelet/crush`](https://github.com/charmbracelet/crush) | 19k+ | P1 | `pack-ap` | done | -| [`oraios/serena`](https://github.com/oraios/serena) | 20k+ | P1 | `pack-aq` | done | -| [`onlook-dev/onlook`](https://github.com/onlook-dev/onlook) | 24k+ | P1 | `pack-aq` | done | -| [`BloopAI/vibe-kanban`](https://github.com/BloopAI/vibe-kanban) | 21k+ | P1 | `pack-as` | done | -| [`winfunc/opcode`](https://github.com/winfunc/opcode) | 20k+ | P1 | `pack-as` | done | -| [`openai/codex`](https://github.com/openai/codex) | 60k+ | P1 | `pack-av` | done | -| [`ChromeDevTools/chrome-devtools-mcp`](https://github.com/ChromeDevTools/chrome-devtools-mcp) | 24k+ | P1 | `pack-av` | done | -| [`anthropics/claude-plugins-official`](https://github.com/anthropics/claude-plugins-official) | 7k+ | P1 | `pack-bb` | done | -| [`EveryInc/compound-engineering-plugin`](https://github.com/EveryInc/compound-engineering-plugin) | 8k+ | P1 | `pack-bb` | done | -| [`affaan-m/everything-claude-code`](https://github.com/affaan-m/everything-claude-code) | 44k+ | P1 | `pack-bc` | done | -| [`OthmanAdi/planning-with-files`](https://github.com/OthmanAdi/planning-with-files) | 13k+ | P1 | `pack-bc` | done | -| [`hesreallyhim/awesome-claude-code`](https://github.com/hesreallyhim/awesome-claude-code) | 23k+ | P1 | `pack-bd` | done | -| [`refly-ai/refly`](https://github.com/refly-ai/refly) | 6k+ | P1 | `pack-bd` | done | -| [`github/github-mcp-server`](https://github.com/github/github-mcp-server) | 26k+ | P1 | `pack-be` | done | -| [`microsoft/playwright-mcp`](https://github.com/microsoft/playwright-mcp) | 27k+ | P1 | `pack-be` | done | -| [`ComposioHQ/awesome-claude-skills`](https://github.com/ComposioHQ/awesome-claude-skills) | 34k+ | P1 | `pack-bf` | done | -| [`musistudio/claude-code-router`](https://github.com/musistudio/claude-code-router) | 27k+ | P1 | `pack-bf` | done | -| [`punkpeye/awesome-mcp-servers`](https://github.com/punkpeye/awesome-mcp-servers) | 80k+ | P1 | `pack-bh` | done | -| [`ComposioHQ/composio`](https://github.com/ComposioHQ/composio) | 26k+ | P1 | `pack-bh` | done | -| [`jlowin/fastmcp`](https://github.com/jlowin/fastmcp) | 22k+ | P1 | `pack-bi` | done | -| [`activepieces/activepieces`](https://github.com/activepieces/activepieces) | 20k+ | P1 | `pack-bi` | done | -| [`daytonaio/daytona`](https://github.com/daytonaio/daytona) | 55k+ | P1 | `pack-bj` | done | -| [`ruvnet/claude-flow`](https://github.com/ruvnet/claude-flow) | 13k+ | P1 | `pack-bj` | done | -| [`modelcontextprotocol/typescript-sdk`](https://github.com/modelcontextprotocol/typescript-sdk) | 11k+ | P1 | `pack-bm` | done | -| [`mcp-use/mcp-use`](https://github.com/mcp-use/mcp-use) | 9k+ | P1 | `pack-bm` | done | -| [`modelcontextprotocol/modelcontextprotocol`](https://github.com/modelcontextprotocol/modelcontextprotocol) | 7k+ | P1 | `pack-bn` | done | -| [`modelcontextprotocol/go-sdk`](https://github.com/modelcontextprotocol/go-sdk) | 3k+ | P1 | `pack-bn` | done | -| [`modelcontextprotocol/java-sdk`](https://github.com/modelcontextprotocol/java-sdk) | 3k+ | P1 | `pack-bo` | done | -| [`modelcontextprotocol/csharp-sdk`](https://github.com/modelcontextprotocol/csharp-sdk) | 3k+ | P1 | `pack-bo` | done | -| [`modelcontextprotocol/rust-sdk`](https://github.com/modelcontextprotocol/rust-sdk) | 3k+ | P1 | `pack-bp` | done | -| [`modelcontextprotocol/swift-sdk`](https://github.com/modelcontextprotocol/swift-sdk) | 1k+ | P1 | `pack-bp` | done | -| [`modelcontextprotocol/kotlin-sdk`](https://github.com/modelcontextprotocol/kotlin-sdk) | 1k+ | P1 | `pack-bq` | done | -| [`modelcontextprotocol/ruby-sdk`](https://github.com/modelcontextprotocol/ruby-sdk) | 700+ | P1 | `pack-bq` | done | -| [`modelcontextprotocol/php-sdk`](https://github.com/modelcontextprotocol/php-sdk) | 1k+ | P1 | `pack-br` | done | -| [`modelcontextprotocol/ext-apps`](https://github.com/modelcontextprotocol/ext-apps) | 1k+ | P1 | `pack-br` | done | -| [`modelcontextprotocol/mcpb`](https://github.com/modelcontextprotocol/mcpb) | 1k+ | P1 | `pack-bs` | done | -| [`modelcontextprotocol/use-mcp`](https://github.com/modelcontextprotocol/use-mcp) | 1k+ | P1 | `pack-bs` | done | -| [`modelcontextprotocol/quickstart-resources`](https://github.com/modelcontextprotocol/quickstart-resources) | 900+ | P1 | `pack-bt` | done | -| [`modelcontextprotocol/create-python-server`](https://github.com/modelcontextprotocol/create-python-server) | 400+ | P1 | `pack-bt` | done | -| [`modelcontextprotocol/docs`](https://github.com/modelcontextprotocol/docs) | 400+ | P1 | `pack-bu` | done | -| [`modelcontextprotocol/create-typescript-server`](https://github.com/modelcontextprotocol/create-typescript-server) | 100+ | P1 | `pack-bu` | done | -| [`TabbyML/tabby`](https://github.com/TabbyML/tabby) | 32k+ | P1 | `pack-bv` | done | -| [`Fission-AI/OpenSpec`](https://github.com/Fission-AI/OpenSpec) | 23k+ | P1 | `pack-bv` | done | -| [`sweepai/sweep`](https://github.com/sweepai/sweep) | 7k+ | P1 | `pack-bw` | done | -| [`stagewise-io/stagewise`](https://github.com/stagewise-io/stagewise) | 6k+ | P1 | `pack-bw` | done | -| [`hangwin/mcp-chrome`](https://github.com/hangwin/mcp-chrome) | 10k+ | P1 | `pack-bx` | done | -| [`firecrawl/firecrawl-mcp-server`](https://github.com/firecrawl/firecrawl-mcp-server) | 5k+ | P1 | `pack-bx` | done | - -## P2 (Strategic Extensions) - -| Repo | Stars | Priority | Pack | Status | -|:-----|------:|:---------|:-----|:-------| -| [`numman-ali/openskills`](https://github.com/numman-ali/openskills) | 8k+ | P2 | `pack-ai` | done | -| [`moazbuilds/CodeMachine-CLI`](https://github.com/moazbuilds/CodeMachine-CLI) | 2k+ | P2 | `pack-ai` | done | -| [`shotgun-sh/shotgun`](https://github.com/shotgun-sh/shotgun) | 500+ | P2 | `pack-aj` | done | -| [`vercel-labs/opensrc`](https://github.com/vercel-labs/opensrc) | 300+ | P2 | `pack-aj` | done | -| [`fireproof-storage/fireproof`](https://github.com/fireproof-storage/fireproof) | 900+ | P2 | `pack-ak` | done | -| [`github/copilot-cli`](https://github.com/github/copilot-cli) | 8k+ | P2 | `pack-al` | done | -| [`MoonshotAI/kimi-cli`](https://github.com/MoonshotAI/kimi-cli) | 6k+ | P2 | `pack-al` | done | -| [`mistralai/mistral-vibe`](https://github.com/mistralai/mistral-vibe) | 3k+ | P2 | `pack-am` | done | -| [`smtg-ai/claude-squad`](https://github.com/smtg-ai/claude-squad) | 5k+ | P2 | `pack-am` | done | -| [`gptme/gptme`](https://github.com/gptme/gptme) | 4k+ | P2 | `pack-an` | done | -| [`campfirein/cipher`](https://github.com/campfirein/cipher) | 3k+ | P2 | `pack-an` | done | -| [`Kilo-Org/kilocode`](https://github.com/Kilo-Org/kilocode) | 15k+ | P2 | `pack-ao` | done | -| [`superset-sh/superset`](https://github.com/superset-sh/superset) | 1.5k+ | P2 | `pack-ao` | done | -| [`upstash/context7`](https://github.com/upstash/context7) | 45k+ | P2 | `pack-ar` | done | -| [`CherryHQ/cherry-studio`](https://github.com/CherryHQ/cherry-studio) | 39k+ | P2 | `pack-ar` | done | -| [`google/adk-python`](https://github.com/google/adk-python) | 17k+ | P2 | `pack-at` | done | -| [`strands-agents/sdk-python`](https://github.com/strands-agents/sdk-python) | 5k+ | P2 | `pack-at` | done | -| [`SWE-agent/SWE-agent`](https://github.com/SWE-agent/SWE-agent) | 18k+ | P2 | `pack-au` | done | -| [`langchain-ai/open-swe`](https://github.com/langchain-ai/open-swe) | 5k+ | P2 | `pack-au` | done | -| [`SWE-agent/mini-swe-agent`](https://github.com/SWE-agent/mini-swe-agent) | 2k+ | P2 | `pack-aw` | done | -| [`QwenLM/Qwen-Agent`](https://github.com/QwenLM/Qwen-Agent) | 13k+ | P2 | `pack-aw` | done | -| [`agentsmd/agents.md`](https://github.com/agentsmd/agents.md) | 17k+ | P2 | `pack-ax` | done | -| [`opencode-ai/opencode`](https://github.com/opencode-ai/opencode) | 10k+ | P2 | `pack-ax` | done | -| [`steveyegge/beads`](https://github.com/steveyegge/beads) | 15k+ | P2 | `pack-ay` | done | -| [`HKUDS/AutoAgent`](https://github.com/HKUDS/AutoAgent) | 8k+ | P2 | `pack-ay` | done | -| [`Fosowl/agenticSeek`](https://github.com/Fosowl/agenticSeek) | 25k+ | P2 | `pack-az` | done | -| [`wshobson/agents`](https://github.com/wshobson/agents) | 28k+ | P2 | `pack-az` | done | -| [`googleapis/genai-toolbox`](https://github.com/googleapis/genai-toolbox) | 12k+ | P2 | `pack-bk` | done | -| [`awslabs/mcp`](https://github.com/awslabs/mcp) | 8k+ | P2 | `pack-bk` | done | -| [`modelcontextprotocol/inspector`](https://github.com/modelcontextprotocol/inspector) | 8k+ | P2 | `pack-bl` | done | -| [`modelcontextprotocol/registry`](https://github.com/modelcontextprotocol/registry) | 6k+ | P2 | `pack-bl` | done | - -## Execution Rules - -1. Each pack is a standalone PR with full chapter docs + index + generated discoverability artifacts. -2. Every PR must pass docs-health, format-v2 checks, and drift checks before merge. -3. Merge order: P0 -> P1 -> P2. -4. Keep this file updated after each merged PR. diff --git a/TUTORIAL_STRUCTURE.md b/TUTORIAL_STRUCTURE.md index c73c7e23..ad339ed3 100644 --- a/TUTORIAL_STRUCTURE.md +++ b/TUTORIAL_STRUCTURE.md @@ -17,7 +17,7 @@ tutorials// | Pattern | Count | |:--------|:------| -| `root_only` | 201 | +| `root_only` | 203 | | `docs_only` | 0 | | `index_only` | 0 | | `mixed` | 0 |