STRUCTURE.md 4.3 KB

Repository Structure

Skill_Seekers/
โ”‚
โ”œโ”€โ”€ ๐Ÿ“„ Root Documentation
โ”‚   โ”œโ”€โ”€ README.md                  # Main documentation (start here!)
โ”‚   โ”œโ”€โ”€ CLAUDE.md                  # Quick reference for Claude Code
โ”‚   โ”œโ”€โ”€ QUICKSTART.md              # 3-step quick start guide
โ”‚   โ”œโ”€โ”€ ROADMAP.md                 # Development roadmap
โ”‚   โ”œโ”€โ”€ TODO.md                    # Current sprint tasks
โ”‚   โ”œโ”€โ”€ STRUCTURE.md               # This file
โ”‚   โ”œโ”€โ”€ LICENSE                    # MIT License
โ”‚   โ””โ”€โ”€ .gitignore                 # Git ignore rules
โ”‚
โ”œโ”€โ”€ ๐Ÿ”ง CLI Tools (cli/)
โ”‚   โ”œโ”€โ”€ doc_scraper.py             # Main scraping tool
โ”‚   โ”œโ”€โ”€ estimate_pages.py          # Page count estimator
โ”‚   โ”œโ”€โ”€ enhance_skill.py           # AI enhancement (API-based)
โ”‚   โ”œโ”€โ”€ enhance_skill_local.py     # AI enhancement (LOCAL, no API)
โ”‚   โ”œโ”€โ”€ package_skill.py           # Skill packaging tool
โ”‚   โ””โ”€โ”€ run_tests.py               # Test runner
โ”‚
โ”œโ”€โ”€ ๐ŸŒ MCP Server (mcp/)
โ”‚   โ”œโ”€โ”€ server.py                  # Main MCP server
โ”‚   โ”œโ”€โ”€ requirements.txt           # MCP dependencies
โ”‚   โ””โ”€โ”€ README.md                  # MCP setup guide
โ”‚
โ”œโ”€โ”€ ๐Ÿ“ configs/                    # Preset configurations
โ”‚   โ”œโ”€โ”€ godot.json
โ”‚   โ”œโ”€โ”€ react.json
โ”‚   โ”œโ”€โ”€ vue.json
โ”‚   โ”œโ”€โ”€ django.json
โ”‚   โ”œโ”€โ”€ fastapi.json
โ”‚   โ”œโ”€โ”€ kubernetes.json
โ”‚   โ””โ”€โ”€ steam-economy-complete.json
โ”‚
โ”œโ”€โ”€ ๐Ÿงช tests/                      # Test suite (71 tests, 100% pass rate)
โ”‚   โ”œโ”€โ”€ test_config_validation.py
โ”‚   โ”œโ”€โ”€ test_integration.py
โ”‚   โ””โ”€โ”€ test_scraper_features.py
โ”‚
โ”œโ”€โ”€ ๐Ÿ“š docs/                       # Detailed documentation
โ”‚   โ”œโ”€โ”€ CLAUDE.md                  # Technical architecture
โ”‚   โ”œโ”€โ”€ ENHANCEMENT.md             # AI enhancement guide
โ”‚   โ”œโ”€โ”€ USAGE.md                   # Complete usage guide
โ”‚   โ”œโ”€โ”€ TESTING.md                 # Testing guide
โ”‚   โ””โ”€โ”€ UPLOAD_GUIDE.md            # How to upload skills
โ”‚
โ”œโ”€โ”€ ๐Ÿ”€ .github/                    # GitHub configuration
โ”‚   โ”œโ”€โ”€ SETUP_GUIDE.md             # GitHub project setup
โ”‚   โ”œโ”€โ”€ ISSUES_TO_CREATE.md        # Issue templates
โ”‚   โ””โ”€โ”€ ISSUE_TEMPLATE/            # Issue templates
โ”‚
โ””โ”€โ”€ ๐Ÿ“ฆ output/                     # Generated skills (git-ignored)
    โ”œโ”€โ”€ {name}_data/               # Scraped raw data (cached)
    โ””โ”€โ”€ {name}/                    # Built skills
        โ”œโ”€โ”€ SKILL.md               # Main skill file
        โ””โ”€โ”€ references/            # Reference documentation

Key Files

For Users:

  • README.md - Start here for overview and installation
  • QUICKSTART.md - Get started in 3 steps
  • configs/ - 7 ready-to-use presets
  • mcp/README.md - MCP server setup for Claude Code

For CLI Usage:

  • cli/doc_scraper.py - Main scraping tool
  • cli/estimate_pages.py - Page count estimator
  • cli/enhance_skill_local.py - Local enhancement (no API key)
  • cli/package_skill.py - Package skills to .zip

For MCP Usage (Claude Code):

  • mcp/server.py - MCP server (6 tools)
  • mcp/README.md - Setup instructions
  • configs/ - Shared configurations

For Developers:

  • docs/CLAUDE.md - Architecture and internals
  • docs/USAGE.md - Complete usage guide
  • docs/TESTING.md - Testing guide
  • tests/ - 71 tests (100% pass rate)

For Contributors:

  • ROADMAP.md - Development roadmap
  • TODO.md - Current sprint tasks
  • .github/SETUP_GUIDE.md - GitHub setup
  • LICENSE - MIT License

Architecture

Monorepo Structure

The repository is organized as a monorepo with two main components:

  1. CLI Tools (cli/): Standalone Python scripts for direct command-line usage
  2. MCP Server (mcp/): Model Context Protocol server for Claude Code integration

Both components share the same configuration files and output directory.

Data Flow

Config (configs/*.json)
  โ†“
CLI Tools OR MCP Server
  โ†“
Scraper (cli/doc_scraper.py)
  โ†“
Output (output/{name}_data/)
  โ†“
Builder (cli/doc_scraper.py)
  โ†“
Skill (output/{name}/)
  โ†“
Enhancer (optional)
  โ†“
Packager (cli/package_skill.py)
  โ†“
Skill .zip (output/{name}.zip)