Skip to content

Redesign Introduction of GitHub as an interactive lesson - #2466

Merged
sanjay-kv merged 1 commit into
mainfrom
docs/github-intro-lesson
Oct 24, 2026
Merged

sanjay-kv merged 1 commit into
mainfrom
docs/github-intro-lesson

Conversation

@sanjay-kv

Copy link
Copy Markdown
Member

What

Redesigns /docs/GitHub/intro-github as a beginner lesson. All existing content is kept; new beginner blocks are added.

  • Lesson header with lesson number, lesson count and reading time computed from the sidebar and the page text (small remark plugin, nothing hardcoded)
  • Git vs GitHub explainer, animated scenario diagram, "every commit is a save point" strip, VCS/DVCS cards
  • Searchable glossary (5 essential terms by default, all 11 on toggle), workflow stepper with typed commands, lite YouTube embed
  • Key takeaways, quick check (GA4 lesson_quiz_answer), "Up next" card read from the sidebar
  • Content column is 808px at a 1440px window (613px at 1180px); the footer uses the same width via a new footer_width: lesson option

Not touched

sidebars.ts, theme components and custom.css. Headings stay ##, so the right contents list still shows its four sections (the video heading is a JSX h3).

Notes

  • The shared DocFooter is reused; it only gains the lesson width option.
  • custom.css forces [role=tab] and [role=tablist] site-wide, so the stepper overrides those with higher-specificity rules inside its own module.
  • npm run build passes.

Adds a lesson header with a computed lesson number, count and reading time,
a Git vs GitHub explainer, animated scenario and save-point diagrams, a
searchable glossary, a workflow stepper, a lite YouTube embed, key takeaways
and a quick check. Existing content is kept. The sidebar, table of contents
and global CSS are untouched. The page and its footer use an 808px column.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@sanjay-kv
sanjay-kv requested a review from Adez017 as a code owner October 24, 2026 14:25
@vercel

vercel Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
recode-website Ready Ready Preview Oct 24, 2026 2:26pm UTC

@github-actions

Copy link
Copy Markdown

Thank you for submitting your pull request! 🙌 We'll review it asap. The estimated time for response is 5–8 hrs.

In the meantime, please provide all necessary screenshots and make sure you run - npm build run , command and provide a screenshot, if it's a Video -LEGEND, which helps speed up the review. If you have questions, reach out to LinkedIn. You can see in our Leaderboard in 20 min from now!😊

Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your PR goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv.

We are here to help you on this journey of open source. Consistent 20 contributions are eligible for sponsorship 💰

🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨

📚Your perks for contribution to this community 👇🏻

  1. Get free Consultation after 5 PR: Mentorship for free.

  2. Get the Ebook for free after 10 PR: You can tag me in Discussion to get the same. Data Science cheatsheet for Beginners.

  3. Check out this weekly Newsletter: Sanjay's Newsletter.

Thanks again for your contribution! 😊

@github-actions github-actions Bot added in-review The current changes are in review and would need approval and testing before merging level 1 10 points recode this is label for leaderboard labels Oct 24, 2026
@github-actions github-actions Bot added this to the recode:launch 3.0 milestone Oct 24, 2026
@sanjay-kv
sanjay-kv merged commit 93e57c3 into main Oct 24, 2026
9 checks passed
@github-actions

Copy link
Copy Markdown

🎉 Your pull request has been successfully merged! 🎉 Thank you for your valuable contribution to our project.

I would be grateful if you can nominate for keeping this opensource project live and running Link to Nominate. Please do star the repo and Keep up the fantastic work! 🚀

This branch was successfully deployed

1 active deployment
Preview — c1158fa5 Deployed Oct 24, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in-review The current changes are in review and would need approval and testing before merging level 1 10 points recode this is label for leaderboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant