docs(A1.9): Add comprehensive git source documentation and example repository
Phase 4 Complete: - Updated README.md with git source usage examples and use cases - Created docs/GIT_CONFIG_SOURCES.md (800+ lines comprehensive guide) - Updated CHANGELOG.md with v2.2.0 release notes - Added configs/example-team/ example repository with E2E test Documentation covers: - Quick start and architecture - MCP tools reference (4 tools with examples) - Authentication for GitHub, GitLab, Bitbucket - Use cases (small teams, enterprise, open source) - Best practices, troubleshooting, advanced topics - Complete API reference Example repository includes: - 3 example configs (react-custom, vue-internal, company-api) - README with usage guide - E2E test script (7 steps, 100% passing) 🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
120
README.md
120
README.md
@@ -72,6 +72,16 @@ Skill Seeker is an automated tool that transforms documentation websites, GitHub
|
||||
- ✅ **Single Source of Truth** - One skill showing both intent (docs) and reality (code)
|
||||
- ✅ **Backward Compatible** - Legacy single-source configs still work
|
||||
|
||||
### 🔐 Private Config Repositories (**NEW - v2.2.0**)
|
||||
- ✅ **Git-Based Config Sources** - Fetch configs from private/team git repositories
|
||||
- ✅ **Multi-Source Management** - Register unlimited GitHub, GitLab, Bitbucket repos
|
||||
- ✅ **Team Collaboration** - Share custom configs across 3-5 person teams
|
||||
- ✅ **Enterprise Support** - Scale to 500+ developers with priority-based resolution
|
||||
- ✅ **Secure Authentication** - Environment variable tokens (GITHUB_TOKEN, GITLAB_TOKEN)
|
||||
- ✅ **Intelligent Caching** - Clone once, pull updates automatically
|
||||
- ✅ **Offline Mode** - Work with cached configs when offline
|
||||
- ✅ **Backward Compatible** - Existing API-based configs still work
|
||||
|
||||
### 🤖 AI & Enhancement
|
||||
- ✅ **AI-Powered Enhancement** - Transforms basic templates into comprehensive guides
|
||||
- ✅ **No API Costs** - FREE local enhancement using Claude Code Max
|
||||
@@ -319,6 +329,116 @@ def move_local_x(delta: float, snap: bool = False) -> None
|
||||
|
||||
**Full Guide:** See [docs/UNIFIED_SCRAPING.md](docs/UNIFIED_SCRAPING.md) for complete documentation.
|
||||
|
||||
### Private Config Repositories (**NEW - v2.2.0**)
|
||||
|
||||
**The Problem:** Teams need to share custom configs for internal documentation, but don't want to publish them publicly.
|
||||
|
||||
**The Solution:** Register private git repositories as config sources. Fetch configs from team repos just like the public API, with full authentication support.
|
||||
|
||||
```bash
|
||||
# Setup: Set your GitHub token (one-time)
|
||||
export GITHUB_TOKEN=ghp_your_token_here
|
||||
|
||||
# Option 1: Using MCP tools (recommended)
|
||||
# Register your team's private repo
|
||||
add_config_source(
|
||||
name="team",
|
||||
git_url="https://github.com/mycompany/skill-configs.git",
|
||||
token_env="GITHUB_TOKEN"
|
||||
)
|
||||
|
||||
# Fetch config from team repo
|
||||
fetch_config(source="team", config_name="internal-api")
|
||||
|
||||
# List all registered sources
|
||||
list_config_sources()
|
||||
|
||||
# Remove source when no longer needed
|
||||
remove_config_source(name="team")
|
||||
```
|
||||
|
||||
**Direct Git URL mode** (no registration):
|
||||
```bash
|
||||
# Fetch directly from git URL
|
||||
fetch_config(
|
||||
git_url="https://github.com/mycompany/configs.git",
|
||||
config_name="react-custom",
|
||||
token="ghp_your_token_here"
|
||||
)
|
||||
```
|
||||
|
||||
**Supported Platforms:**
|
||||
- GitHub (token env: `GITHUB_TOKEN`)
|
||||
- GitLab (token env: `GITLAB_TOKEN`)
|
||||
- Gitea (token env: `GITEA_TOKEN`)
|
||||
- Bitbucket (token env: `BITBUCKET_TOKEN`)
|
||||
- Any git server (token env: `GIT_TOKEN`)
|
||||
|
||||
**Use Cases:**
|
||||
|
||||
📋 **Small Teams (3-5 people)**
|
||||
```bash
|
||||
# Team lead creates repo
|
||||
gh repo create myteam/skill-configs --private
|
||||
|
||||
# Add configs to repo
|
||||
cd myteam-skill-configs
|
||||
cp ../Skill_Seekers/configs/react.json ./react-custom.json
|
||||
# Edit selectors, categories for your internal docs...
|
||||
git add . && git commit -m "Add custom React config" && git push
|
||||
|
||||
# Team members register (one-time)
|
||||
add_config_source(name="team", git_url="https://github.com/myteam/skill-configs.git")
|
||||
|
||||
# Everyone can now fetch
|
||||
fetch_config(source="team", config_name="react-custom")
|
||||
```
|
||||
|
||||
🏢 **Enterprise (500+ developers)**
|
||||
```bash
|
||||
# IT pre-configures sources for everyone
|
||||
add_config_source(name="platform", git_url="gitlab.company.com/platform/configs", priority=1)
|
||||
add_config_source(name="mobile", git_url="gitlab.company.com/mobile/configs", priority=2)
|
||||
add_config_source(name="official", git_url="api.skillseekersweb.com", priority=3)
|
||||
|
||||
# Developers use transparently
|
||||
fetch_config(config_name="internal-platform") # Finds in platform source
|
||||
fetch_config(config_name="react") # Falls back to official API
|
||||
```
|
||||
|
||||
**Storage Locations:**
|
||||
- Registry: `~/.skill-seekers/sources.json`
|
||||
- Cache: `$SKILL_SEEKERS_CACHE_DIR` (default: `~/.skill-seekers/cache/`)
|
||||
|
||||
**Features:**
|
||||
- ✅ **Shallow clone** - 10-50x faster, minimal disk space
|
||||
- ✅ **Auto-pull** - Fetches latest changes automatically
|
||||
- ✅ **Offline mode** - Works with cached repos when offline
|
||||
- ✅ **Priority resolution** - Multiple sources with conflict resolution
|
||||
- ✅ **Secure** - Tokens via environment variables only
|
||||
|
||||
**Example Team Repository:**
|
||||
|
||||
Try the included example:
|
||||
```bash
|
||||
# Test with file:// URL (no auth needed)
|
||||
cd /path/to/Skill_Seekers
|
||||
|
||||
# Run the E2E test
|
||||
python3 configs/example-team/test_e2e.py
|
||||
|
||||
# Or test manually
|
||||
add_config_source(
|
||||
name="example",
|
||||
git_url="file://$(pwd)/configs/example-team",
|
||||
branch="master"
|
||||
)
|
||||
|
||||
fetch_config(source="example", config_name="react-custom")
|
||||
```
|
||||
|
||||
**Full Guide:** See [docs/GIT_CONFIG_SOURCES.md](docs/GIT_CONFIG_SOURCES.md) for complete documentation.
|
||||
|
||||
## How It Works
|
||||
|
||||
```mermaid
|
||||
|
||||
Reference in New Issue
Block a user