Skip to content

Redesign README with hero section, visual tracks, and full course overview#316

Merged
bdorlus merged 1 commit into
mainfrom
claude/review-merge-prs-yNAhm
May 19, 2026
Merged

Redesign README with hero section, visual tracks, and full course overview#316
bdorlus merged 1 commit into
mainfrom
claude/review-merge-prs-yNAhm

Conversation

@bdorlus
Copy link
Copy Markdown
Member

@bdorlus bdorlus commented May 19, 2026

Summary

Full README overhaul to make the repository's first impression reflect the quality and ambition of the course itself.

What changed

  • Hero section — centered logo, bold tagline, stat pills (276 lessons, 31 chapters), live course site badge, GitHub Stars/License badges, and the operator loop SVG graphic — all above the fold
  • "For the culture" mission statement — speaks directly to career switchers, self-taught learners, bootcamp grads, and anyone who's felt gated out of Linux knowledge
  • Audience matrix table — 5 learner profiles (beginner, help desk, software engineer, cloud/DevOps/SRE, cybersecurity) each mapped to a clear value proposition
  • Four-track ASCII learning map — visual block showing Foundations → Services → Operations Depth → Professional Practice with chapter ranges
  • Collapsible 31-chapter table — all chapters with key skills, collapsed by default to keep the README scannable
  • Time commitment table — per-lesson, per-chapter, full course, and capstone estimates
  • Three quick-start options — web (zero setup), local make serve, static build
  • Lesson structure breakdown — the 5 questions every lesson answers
  • Capstone project summary — what it asks learners to build and prove
  • Lab safety callout — reinforces the VM-first habit
  • Contribute & community section — issue, PR, star, and share CTAs
  • Closing social badges — star and fork shields with humanizing sign-off

Accessibility improvements (also on this branch)

  • Glossary expanded from 12 → 65 terms covering all major course concepts
  • Course overview updated with time estimates, operator loop diagram, safety boundaries, and chapter workflow guide
  • Landing page (docs/index.md) updated with audience-based "Where to begin" quick-start cards
  • mkdocs.yml updated with instant navigation, progress bar, breadcrumb path, and shareable search links

Test plan

  • View the README on GitHub — verify hero renders, badges load, collapsible chapter list works
  • Confirm mkdocs build --strict still passes
  • Check that all links in the README resolve (course site, syllabus, glossary, capstone, lab setup, issues, PRs)

Generated by Claude Code

…rview

Full README overhaul for discoverability and first-impression impact:
- Centered hero: logo, tagline, stat pills, live badge, star/fork badges
- Operator loop diagram embedded in hero
- "For the culture" mission statement section
- Audience matrix table (5 learner profiles with value propositions)
- ASCII art four-track learning map
- Collapsible 31-chapter table with key skills per chapter
- Time commitment table
- Three quick-start options (web, local, static build)
- Lesson structure breakdown (the 5 questions every lesson answers)
- Capstone project summary with link
- Lab safety callout
- Contribute & community section with actionable next steps
- Repository layout tree
- Closing CTA with star/fork social badges
@bdorlus bdorlus merged commit ae83a2e into main May 19, 2026
1 check passed
@bdorlus bdorlus deleted the claude/review-merge-prs-yNAhm branch May 19, 2026 02:18
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.

2 participants