feat: comprehensive help system for teach dispatcher (v5.14.0) #281
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated CHANGELOG.md with Phase 2 features - Enhanced CLAUDE.md with recent completions - Updated teaching guides and refcards - Added REFCARD-QUARTO-PHASE2.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add Quick Start section to main teach --help - Reorganize help into workflow phases (Setup, Content, Validation, Deploy, Advanced) - Create help functions for teach lecture, teach doctor, teach deploy - Add progressive examples with $ prompt prefix - Create 8-step Quick Start tutorial (15 min) - Update mkdocs.yml navigation for tutorial ✅ Verified: All help outputs render correctly, mkdocs builds, tests pass
…cumentation - Fix color inconsistency in USAGE lines - Add --help routing to all 7 Scholar wrappers (slides, exam, quiz, assignment, syllabus, rubric, feedback) - Add ALIASES section to all help functions - Add TROUBLESHOOTING section with 3 common issues - Add REQUIRED FILES section to lecture help - Add LEARN MORE section with tutorial and guide links - Create 7 new help functions for all Scholar commands ✅ Verified: All help outputs render correctly
- Create _teach_validate_help() with validation modes and custom validators - Create _teach_cache_help() with subcommand documentation - Create _teach_profiles_help() for Quarto profile management - Create _teach_clean_help() with WARNING about irreversible action - Upgrade _teach_status_help() with PERFORMANCE DASHBOARD section - Upgrade _teach_week_help() with box styling - Upgrade _teach_backup_help() to FLOW_COLORS (remove old _C_BOLD vars) - Add --help routing to validate, cache, profiles, clean commands ✅ All help functions render correctly with box styling
- Add box styling (╔═╗) to all backup subcommand helps - Add FLOW_COLORS throughout (no plain bold) - Add DESCRIPTION, ARGUMENTS, OPTIONS sections to each - Add EXIT CODES to restore command - Add CONFIRMATION section to delete command - Add RETENTION POLICY to archive command - Add TIPS, LEARN MORE, SEE ALSO sections Subcommands upgraded: - teach backup create - teach backup list - teach backup restore - teach backup delete - teach backup archive ✅ All backup helps now consistent with other help functions
- Add box styling to _teach_init_help() - Add ALIASES, TIPS, OUTPUT, SEE ALSO sections to init help - Add --help routing to init command - Create _teach_config_help() with box styling - Add --help routing to config command - Add --view, --cat, --edit options for config ✅ Both commands now have comprehensive help with examples
docs/commands/teach.md: - Add 8 new commands to table (doctor, hooks, dates, validate, profiles, cache, clean, backup) - Fix deprecated help → --help flag - Add Additional Commands section with examples - Add teach config --view and --cat options docs/guides/TEACHING-WORKFLOW-V3-GUIDE.md: - Add Content Validation section for teach validate - Add backup subcommand reference docs/commands/teach-init.md: - Add --github flag to Options table - Update examples with --github usage docs/tutorials/14-teach-dispatcher.md: - Update version from v5.9.0+ to v5.14.0 - Clean up legacy workflow note docs/guides/BACKUP-SYSTEM-GUIDE.md: - Add Command Reference section for backup subcommands ✅ mkdocs builds successfully
- Add HELP-SYSTEM-GUIDE.md (800 lines) - Complete help system documentation - Add REFCARD-HELP-SYSTEM.md (450 lines) - Quick reference card - Update mkdocs.yml navigation with 2 new entries Documents all 18 help functions, help structure patterns, progressive disclosure design, ADHD-friendly principles, and implementation details. Related: PR #281 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements a comprehensive help system for the
teachdispatcher with consistent box styling, progressive disclosure, and thorough documentation.Key Changes
Help Functions (20+ new/enhanced):
teach --helpwith workflow-ordered commandsConsistency Standards Applied:
╔═╗) on all help functionsFLOW_COLORSthroughout (no plain ANSI codes)$prompt prefix on all examplesDocumentation Updates:
docs/tutorials/TEACHING-QUICK-START.md(419 lines, 8 steps)docs/commands/teach.mdwith all commandsdocs/commands/teach-init.mdwith --github flagdocs/guides/TEACHING-WORKFLOW-V3-GUIDE.mdwith validate and backupdocs/tutorials/14-teach-dispatcher.mdto v5.14.0docs/guides/BACKUP-SYSTEM-GUIDE.mdwith command referenceVerification
Breaking Changes
None - all changes are additive and backward compatible.