Skip to content

docs: refresh README#4

Open
hashildy wants to merge 1 commit into
mainfrom
chore/docs-readme
Open

docs: refresh README#4
hashildy wants to merge 1 commit into
mainfrom
chore/docs-readme

Conversation

@hashildy

Copy link
Copy Markdown
Owner

What

Refreshes README.md to accurately describe this repository now that the GitHub Learning Lab "Communicate using Markdown" course is complete.

Why

The previous README was the in-course bot intro message ("I'm the GitHub Learning Lab bot..."), which addresses the reader as if mid-tutorial and references an issue/activity flow that no longer applies. It didn't describe what the repo actually contains.

Changes

  • Describe the repo as a completed Markdown portfolio site (Jekyll + GitHub Pages).
  • Add a file overview table (index.md, _includes/01-name.md, _config.yml, LICENSE).
  • Add a short "Viewing the site" section with the local preview command.
  • Keep a brief note on the course origin.
  • Preserve the MIT license attribution (c) 2019 GitHub, Inc.

Only README.md is touched. All content is based on files actually present in the repo.

Update the README to describe the completed portfolio repository
(structure, viewing via GitHub Pages, and the course origin) instead
of the mid-tutorial GitHub Learning Lab bot intro. Preserves the
MIT license attribution.

Co-Authored-By: Claude Opus 4.8 <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.

2 participants