Skip to main content

Help Documentation Task List

Help Documentation Task List

Created: 2025-12-11 Status: In Progress Priority: High - User Experience

Summary​

CategoryTotalCompleteIncomplete% Done
Slash Commands115427337%
Python Scripts argparse20101050%
Database Indexes41410100%

Scripts completed this session (2025-12-11): 8 scripts updated with argparse -h help

Part 1: Slash Commands Missing ## Usage Sections (73 commands)​

Each command needs a standardized structure:

# /command-name - Short Description

Brief description of what the command does.

## Usage

\`\`\`bash
/command-name [options] [arguments]
\`\`\`

## Options

| Option | Description |
|--------|-------------|
| `--option` | What it does |

## Examples

\`\`\`bash
/command-name --example
\`\`\`

## System Prompt

[The actual prompt that gets executed]

Priority 1: Core Commands (15)​

  • commands/analyze.md - Code analysis
  • commands/implement.md - Implementation mode
  • commands/debug.md - Debug mode
  • commands/commit.md - Git commits
  • commands/git-sync.md - Git synchronization
  • commands/research.md - Research mode
  • commands/strategy.md - Architecture planning
  • commands/prototype.md - Rapid prototyping
  • commands/document.md - Documentation generation
  • commands/optimize.md - Performance optimization
  • commands/action.md - Implementation mode
  • commands/deliberation.md - Planning mode
  • commands/new-project.md - Project creation
  • commands/run-tests.md - Test execution
  • commands/validate-plan.md - Plan validation

Priority 2: Development Commands (20)​

  • commands/a11y.md - Accessibility auditing
  • commands/ai-review.md - AI code review
  • commands/code-explain.md - Code explanation
  • commands/component-scaffold.md - Component scaffolding
  • commands/config-validate.md - Configuration validation
  • commands/create-plan.md - Plan creation
  • commands/db-migrations.md - Database migrations
  • commands/describe-pr.md - PR description
  • commands/doc-generate.md - Documentation generation
  • commands/error-analysis.md - Error analysis
  • commands/error-trace.md - Error tracing
  • commands/full-review.md - Comprehensive review
  • commands/motion.md - Animation integration
  • commands/pr-enhance.md - PR enhancement
  • commands/refactor-clean.md - Code refactoring
  • commands/rust-scaffold.md - Rust scaffolding
  • commands/python-scaffold.md - Python scaffolding
  • commands/typescript-scaffold.md - TypeScript scaffolding
  • commands/test-generate.md - Test generation
  • commands/ui.md - UI component generation

Priority 3: Workflow Commands (18)​

  • commands/analyze-hooks.md - Hooks analysis
  • commands/batch-setup-submodules.md - Batch submodule setup
  • commands/complexity-gauge.md - Complexity monitoring
  • commands/context-save.md - Context saving
  • commands/create-handoff.md - Handoff creation
  • commands/create-worktree.md - Worktree creation
  • commands/export-dedup-enhanced.md - Enhanced export
  • commands/fix-mermaid-diagrams.md - Mermaid fixing
  • commands/generate-curriculum-content.md - Curriculum generation
  • commands/generate-project-plan-hooks.md - Project plan hooks
  • commands/implement-plan.md - Plan implementation
  • commands/local-review.md - Local review
  • commands/recursive-workflow.md - Recursive workflows
  • commands/research-codebase.md - Codebase research
  • commands/resume-handoff.md - Handoff resume
  • commands/setup-submodule.md - Submodule setup
  • commands/submodule-status.md - Submodule status
  • commands/verify-submodule.md - Submodule verification

Priority 4: Specialized Commands (20)​

  • commands/feature-development.md - Feature development
  • commands/hello.md - Test command
  • commands/incident-response.md - Incident response
  • commands/linear.md - Linear integration
  • commands/monitor-setup.md - Monitoring setup
  • commands/oneshot.md - One-shot workflow
  • commands/oneshot-plan.md - One-shot planning
  • commands/ralph-impl.md - Ralph implementation
  • commands/ralph-plan.md - Ralph planning
  • commands/ralph-research.md - Ralph research
  • commands/security-hardening.md - Security hardening
  • commands/security-sast.md - SAST scanning
  • commands/slo-implement.md - SLO implementation
  • commands/smart-debug.md - Smart debugging
  • commands/tdd-cycle.md - TDD workflow
  • commands/tech-debt.md - Tech debt analysis
  • commands/test-coverage.md - Test coverage
  • commands/web-archive.md - Web archiving
  • commands/web-search-hooks.md - Web search hooks

Part 2: Python Scripts Missing -h Help (20 scripts)​

Each script needs argparse with:

  • Description
  • Positional arguments
  • Optional arguments with help text
  • Examples in epilog

Scripts Needing argparse​

  • scripts/__init__.py - (Skip - module init, no CLI)
  • scripts/activate-all-components.py - Component activation ✅ Added 2025-12-11
  • scripts/activate-project-components.py - Project component activation ✅ Added 2025-12-11
  • scripts/add-action-policies.py - Action policy management ✅ Added 2025-12-11
  • scripts/analyze_navigation.py - Navigation analysis ✅ Added 2025-12-11
  • scripts/batch-update-agents-claude45.py - Batch agent update ✅ Added 2025-12-11
  • scripts/batch-update-component-counts.py - Component count update (already has argparse in docstring)
  • scripts/coditect-interactive-setup.py - Interactive setup (class-based, complex)
  • scripts/coditect-setup.py - Setup script (class-based, complex)
  • scripts/enhance-hooks.py - Hook enhancement ✅ Added 2025-12-11
  • scripts/export-dedup-with-status.py - Export with status (complex, 780 lines)
  • scripts/extract-diagrams.py - Diagram extraction ✅ Added 2025-12-11
  • scripts/extract-framework-metadata.py - Metadata extraction
  • scripts/ingest-to-knowledge-db.py - Knowledge ingestion
  • scripts/llm_abstractions.py - (Skip - module, no CLI)
  • scripts/process_exports_poc.py - Export processing POC (demo script)
  • scripts/process_same_session_demo.py - Demo script
  • scripts/test-framework-knowledge.py - Framework testing (test script)
  • scripts/test-interactive-project-builder.py - Builder testing (test script)
  • scripts/verify-critical-components.py - Component verification ✅ Added 2025-12-11

Part 3: Database Indexes (COMPLETED)​

All indexes added as of 2025-12-11:

Memory System (6)​

  • idx_messages_role
  • idx_messages_timestamp
  • idx_messages_session
  • idx_messages_source
  • idx_messages_length
  • idx_embeddings_message

Knowledge System (9)​

  • idx_decisions_type
  • idx_decisions_project
  • idx_decisions_created
  • idx_decisions_confidence (NEW)
  • idx_patterns_language
  • idx_patterns_type
  • idx_patterns_name
  • idx_patterns_usage (NEW)
  • idx_patterns_created (NEW)

Error Solutions (3)​

  • idx_errors_type
  • idx_errors_hash
  • idx_errors_language
  • idx_links_session_a
  • idx_links_session_b

Project Summaries (1)​

  • idx_summaries_project

LMS System (17)​

  • idx_users_user_id
  • idx_users_experience
  • idx_users_last_activity
  • idx_modules_type
  • idx_modules_category
  • idx_modules_difficulty
  • idx_modules_sort
  • idx_progress_user
  • idx_progress_module
  • idx_progress_status
  • idx_progress_completed
  • idx_badges_key
  • idx_badges_category
  • idx_achievements_user
  • idx_achievements_badge
  • idx_achievements_earned
  • idx_events_user
  • idx_events_type
  • idx_events_timestamp
  • idx_events_session

FTS5 Virtual Tables (3)​

  • messages_fts
  • decisions_fts
  • errors_fts

Execution Plan​

Phase 1: Core Commands (1-2 days)​

  • Document 15 most-used commands
  • Standard template for all

Phase 2: Development Commands (2-3 days)​

  • Document 20 development-focused commands
  • Include examples and edge cases

Phase 3: Workflow Commands (2 days)​

  • Document 18 workflow commands
  • Cross-reference related commands

Phase 4: Specialized Commands (2 days)​

  • Document remaining 20 commands
  • Complete coverage

Phase 5: Script Help (2 days)​

  • Add argparse to 20 scripts
  • Consistent help format

Template for Command Documentation​

# /command-name - Brief Description

One-line description of what the command does.

## Usage

\`\`\`bash
# Basic usage
/command-name

# With options
/command-name --option value

# With arguments
/command-name argument
\`\`\`

## Options

| Option | Description | Default |
|--------|-------------|---------|
| `--option` | What this option does | `default` |
| `-s, --short` | Short form option | - |

## Examples

### Example 1: Basic Usage
\`\`\`bash
/command-name
\`\`\`
**Result:** Description of what happens

### Example 2: With Options
\`\`\`bash
/command-name --option value
\`\`\`
**Result:** Description of what happens

## System Prompt

[The actual system prompt that gets executed when command is run]

## Related Commands

- `/related-command` - How it relates
- `/another-command` - How it relates

---

**Script:** `scripts/script-name.py` (if applicable)
**Version:** 1.0.0
**Last Updated:** YYYY-MM-DD

Progress Tracking​

DateCommands DoneScripts DoneNotes
2025-12-110/730/20Task list created, indexes added
2025-12-110/7310/208 scripts updated with argparse -h help (activate-all-components, activate-project-components, add-action-policies, analyze_navigation, batch-update-agents-claude45, enhance-hooks, extract-diagrams, verify-critical-components)

Last Updated: 2025-12-11