Skip to content

docs: Release ADHD-friendly documentation enhancements - #210

Merged
Data-Wise merged 5 commits into
mainfrom
dev
Jan 11, 2026
Merged

Data-Wise merged 5 commits into
mainfrom
dev

Conversation

@Data-Wise

Copy link
Copy Markdown
Owner

Release Summary

Deploy ADHD-friendly documentation enhancements from dev to production.

Changes in This Release

Documentation Enhancements (PR #209)

New Pages:

  • 🆘 I'm Stuck - Emergency troubleshooting guide
  • 🎯 Choose Your Path - Role-based onboarding for different learning styles
  • 📋 Quick Reference Card - Printable one-page command reference

Homepage Improvements:

  • Added TL;DR callout for 30-second quick start
  • Path selection grid with visual cards
  • Better first-impression experience

Visual Enhancements:

  • ADHD-friendly CSS improvements (160 new lines)
  • Color-coded callout boxes for better hierarchy
  • Dark mode support for all new styles
  • Mobile responsive design
  • Print-optimized reference card

Navigation Updates:

  • Reorganized Getting Started section
  • Added emoji indicators for quick scanning
  • Quick Reference Card in main navigation

Impact

User Benefits:
✅ Reduced support burden with self-service troubleshooting
✅ Improved onboarding for different learning styles
✅ Quick command lookup with printable reference
✅ Better visual hierarchy reduces cognitive load

Metrics:

  • 6 files changed, 674 lines added
  • 3 new documentation pages
  • 0 breaking changes
  • 100% backwards compatible

Testing

  • mkdocs build successful (no errors)
  • All internal links resolve
  • Print layout verified
  • Dark mode support confirmed
  • Mobile responsive tested
  • Merged to dev without issues

Deployment

Once merged to main:

Commits Included

784d968 docs: add ADHD-friendly documentation enhancements (#209)
2eb6501 docs: add two additional spec files for future planning
0519d50 chore: update .STATUS with teaching workflow session
b805c2e docs: add teaching workflow specification
70f57f3 docs: add workflow protocol for feature development

Ready to deploy! 🚀

/cc @Data-Wise

Data-Wise and others added 5 commits January 11, 2026 14:47
Created .claude/WORKFLOW-PROTOCOL.md:
- Planning phase on dev branch
- Commit planning docs before worktree creation
- Create worktree from dev
- Ask user to start NEW session for implementation

Updated CLAUDE.md:
- Added critical workflow protocol section
- Reference to detailed protocol document

This ensures clean separation:
- Planning session (dev) = design, specs, approval
- Implementation session (worktree) = focused coding

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Created comprehensive spec for universal teaching workflow:
- STAT 545 as first implementation
- Teaching-aware work command
- Per-course .flow/teach-config.yml
- 3-tier automation (scripts + flow-cli + GitHub Actions)
- Integration with scholar and nexus
- teach-init command for course scaffolding

From brainstorm session with extensive user requirements gathering.
Approved plan ready for implementation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Session accomplishments:
- Branch cleanup (9 local, 4 remote branches)
- Established dev branch workflow (feature → dev → main)
- Created workflow protocol (.claude/WORKFLOW-*.md)
- Created teaching workflow spec (911 lines, approved)
- Created teaching-workflow worktree (ready for impl)

Documentation updates:
- BRANCH-WORKFLOW.md (323 lines)
- WORKFLOW-PROTOCOL.md (197 lines)
- SPEC-teaching-workflow.md (911 lines)
- Updated CLAUDE.md, PR-WORKFLOW-GUIDE.md

PRs merged: #207 (v5.3.0 roadmap), #208 (dev workflow)

Session: 2.5 hours
Next: NEW session in worktree per protocol

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added spec files:
- SPEC-Flow-CLI-Documentation-Enhancement - Complete-Implementation.md
  (1270 lines, ADHD-friendly docs redesign)
- SPEC-STAT-545-COMPREHENSIVE-PLAN.md
  (1418 lines, course migration plan)

These specs were created alongside the teaching workflow spec
but represent separate features for future implementation.

Status: Ready for review and planning

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
New files:
- docs/getting-started/im-stuck.md - Troubleshooting guide with quick fixes
- docs/getting-started/choose-your-path.md - Role-based onboarding paths
- docs/quick-reference-card.md - Printable command reference
- docs/stylesheets/extra.css - ADHD-friendly visual enhancements

Modified files:
- docs/index.md - Added TL;DR callout and path selection grid
- mkdocs.yml - Updated navigation with new pages

Features:
- Progressive disclosure design (quick wins up front)
- Visual hierarchy with colored callout boxes
- Print-friendly reference card
- Grid-based path selection on homepage
- Dark mode support for all new styles
- Mobile responsive design

Impact: Improves discoverability, reduces cognitive load, provides
clear entry points for different learning styles.

Based on complete implementation spec (1,270 lines)

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@Data-Wise
Data-Wise merged commit 4ebd303 into main Jan 11, 2026
2 checks passed
Data-Wise added a commit that referenced this pull request Jan 11, 2026
- Documentation Enhancement shipped to production
- PRs #209 and #210 merged and deployed
- All 3 new pages live on documentation site
- Impact: improved onboarding, troubleshooting, and reference

Session time: ~3 hours (planning → implementation → deploy)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Data-Wise added a commit that referenced this pull request Jan 11, 2026
- Documentation Enhancement shipped to production
- PRs #209 and #210 merged and deployed
- All 3 new pages live on documentation site
- Impact: improved onboarding, troubleshooting, and reference

Session time: ~3 hours (planning → implementation → deploy)

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Data-Wise added a commit that referenced this pull request Sep 5, 2026
create-github-app-token was called with no permission-* inputs, so the
minted token inherited EVERY permission the data-wise-homebrew-automation
installation holds on homebrew-tap, for the duration of the job — a job
that runs sed, git and gh against a live credential.

The step needs exactly two things: commit and push the formula edit
(contents: write), and open then auto-merge the bump PR
(pull-requests: write) — the latter added by #499.

Both are known-granted, not guessed: the App has authored 7 PRs on the tap
(#215, #214, #213, #212, #210, #209, #207) and merged its own (#212, #210
show mergedBy = app/data-wise-homebrew-automation), which requires
pull-requests: write; the formula pushes require contents: write.

Least privilege on an existing credential — no behaviour change intended.
create-github-app-token fails at mint time if a requested permission is not
granted, so a mismatch surfaces immediately rather than silently.

Verified: actionlint reports the same 2 pre-existing SC2086 infos before
and after (different step, not introduced here); YAML parses and both keys
land in the app-token step's with: block.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant