Reorganize repository structure and clean up documentation
Clean up and organize the flask-shopdb repository for better maintainability and discoverability: ## Changes - Update .gitignore for build artifacts (publish/, data/, 122M total) - Reorganize .claude/ into 6 subdirectories with README navigation - Consolidate overlapping MCP setup guides into MCP-QUICK-START.md - Move deployment docs from root to docs/deployment/ - Archive dated status reports to .claude/archived/ - Delete temporary files (logs, backups, empty reports, ~50K) ## New Structure .claude/ organized into: - setup/ - MCP, VM, Hyper-V, GitHub setup guides + scripts (17 files) - plans/ - Feature plans and protocols (5 files) - maintenance/ - Deployment checklists and reports (4 files) - archived/ - Historical documentation (9 files) - skills/ - Claude Code automation (5 files) - workflows/ - Security audit workflow (1 file) docs/deployment/ created with 6 deployment guides: - LOCAL-DEV-SETUP.md, DOCKER-SETUP.md, DOCKER-PREBUILT-APPROACH.md - PRODUCTION-READINESS.md, DEPLOY-TO-VM.md, README.md Root directory cleaned to essential docs only: - CLAUDE.md, README.md, CONTRIBUTING.md, CHANGELOG.md Benefits: - Clear navigation via README.md in each subdirectory - No duplicate/overlapping documentation - Large artifacts properly gitignored (won't bloat repository) - Historical context preserved in archived/ See .claude/CLEANUP-SUMMARY.md for complete details. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
78
.claude/skills/README.md
Normal file
78
.claude/skills/README.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# ShopDB Skills
|
||||
|
||||
Custom slash commands for common workflows.
|
||||
|
||||
## Available Skills
|
||||
|
||||
### `/build-agent`
|
||||
Build and publish agent and tray executables to Documents/shopdb-builds folder.
|
||||
|
||||
**When to use:** After making changes to agent or tray C# code, before deployment.
|
||||
|
||||
**What it does:**
|
||||
- Compiles both executables
|
||||
- Creates dated folder in Documents
|
||||
- Generates VERSION.txt with release notes
|
||||
- Copies .exe files ready for deployment
|
||||
|
||||
### `/merge-wilm`
|
||||
Merge latest wilm branch commits into wj with proper conflict resolution.
|
||||
|
||||
**When to use:** Periodically to bring wilm improvements into wj prod branch.
|
||||
|
||||
**What it does:**
|
||||
- Fetches latest from origin
|
||||
- Shows commits to be merged
|
||||
- Handles common conflicts (csproj, routes.py)
|
||||
- Coordinates agent/tray versions
|
||||
- Creates merge commit
|
||||
|
||||
### `/deploy-frontend`
|
||||
Build frontend and deploy to prod server via Y drive.
|
||||
|
||||
**When to use:** After making Vue/frontend changes that need to go to production.
|
||||
|
||||
**What it does:**
|
||||
- Runs production build with correct VITE_BASE_PATH
|
||||
- Copies dist/ to Y: drive
|
||||
- Provides instructions for IIS restart
|
||||
- Verifies build output
|
||||
|
||||
### `/test-changes`
|
||||
Run pytest and frontend build checks before committing.
|
||||
|
||||
**When to use:** Before claiming work is complete or pushing commits.
|
||||
|
||||
**What it does:**
|
||||
- Runs pytest for backend
|
||||
- Builds frontend to catch errors
|
||||
- Runs style/naming checker
|
||||
- Provides targeted test commands
|
||||
|
||||
## How Skills Work
|
||||
|
||||
Skills are markdown files that provide structured instructions. When you type `/skill-name`, Claude:
|
||||
1. Loads the skill instructions
|
||||
2. Follows the steps defined in the skill
|
||||
3. Adapts to the current situation
|
||||
|
||||
Skills save tokens by avoiding repeated explanations of common workflows.
|
||||
|
||||
## Tips
|
||||
|
||||
- Use skills for repetitive tasks
|
||||
- Skills preserve context about your environment
|
||||
- You can still ask Claude to deviate from skill steps if needed
|
||||
- Skills work best when the workflow is consistent
|
||||
|
||||
## Adding New Skills
|
||||
|
||||
Create a new `.md` file in `.claude/skills/` with:
|
||||
```markdown
|
||||
---
|
||||
name: skill-name
|
||||
description: Brief description
|
||||
---
|
||||
|
||||
Instructions for Claude to follow...
|
||||
```
|
||||
Reference in New Issue
Block a user