Skip to content

docs(readme): premium LMS-style landing page with live Loop Ready demo - #6

Merged
SARAMALI15792 merged 1 commit into
mainfrom
feat/Enhance-Readme
Jul 24, 2026
Merged

docs(readme): premium LMS-style landing page with live Loop Ready demo#6
SARAMALI15792 merged 1 commit into
mainfrom
feat/Enhance-Readme

Conversation

@SARAMALI15792

Copy link
Copy Markdown
Collaborator

What this changes

Rebuilds README.md as a premium, LMS-style landing page (modeled on the loop-engineering reference repo), backed by real tooling instead of static images.

README

  • Badges first, hero second: three centered rows — live GitHub badges (stars, last commit, repo size, contributors, Loop Ready audit status), core course badges, and course-status tags — followed by a new animated hero banner.
  • LMS structure: Quick Links, Choose Your Track, Curriculum (six parts with Start → links, plus Methods / Operating / Labs / Advanced / Certification), Anatomy of a Loop (mermaid), 20-pattern library table, Getting Started, Operating & Safety, Certification, Repository Map.
  • Clickable labels: course links read as View → / Start → actions instead of raw file paths.

New assets (both generated/animated SVG, no GIFs)

  • assets/hero-banner.svg — animated hero: rotating orbit, pulsing heartbeat node, six-part loop motif.
  • assets/terminal-loop-ready.svg — terminal demo rendered from a real run of the Loop Ready audit: ten check rows stream in while a score ring climbs to the actual score.

Tooling (keeps the demo honest)

  • scripts/loop-ready-audit.mjs: new --json flag; human output byte-identical to before.
  • scripts/render-loop-ready-terminal.mjs (+ npm run render:terminal): draws the terminal SVG from the audit's JSON — real kit counts, real exit code; a failing kit renders red and caps the score below 100 (floor, not round).
  • .github/workflows/loop-ready.yml: re-runs the audit on every push/PR (badge goes red on failure) and re-renders the demo, committing it back on main only when it changed.

Verification

  • markdownlint-cli2 README.md — 0 issues against .markdownlint.jsonc
  • Every relative link in the README checked against the filesystem — all resolve
  • Renderer failure path tested by temporarily breaking a kit: red ✖ row, 19/20 counts, score 99, exit 1
  • npm run audit:loops default output unchanged

🤖 Generated with Claude Code

https://claude.ai/code/session_0137HmDLUvJxjF4udCAvdKbG

…it demo

- badges first (dynamic GitHub + course-status rows), then a new animated
  hero banner (assets/hero-banner.svg) with the six-part loop motif
- terminal demo (assets/terminal-loop-ready.svg) rendered from a REAL run
  of the Loop Ready audit: ten check rows stream in while the score ring
  climbs to the actual score; failures render red and cap the score
- loop-ready-audit.mjs gains a --json mode (human output unchanged);
  render-loop-ready-terminal.mjs draws the SVG from that data
- loop-ready.yml workflow re-runs the audit and re-renders the demo on
  every push, with a live status badge in the README
- course links now read as View → / Start → actions instead of file paths

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0137HmDLUvJxjF4udCAvdKbG
@SARAMALI15792
SARAMALI15792 merged commit e930a5d into main Jul 24, 2026
3 checks passed
@SARAMALI15792
SARAMALI15792 deleted the feat/Enhance-Readme branch July 24, 2026 12:36
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