Skip to content

Fix formatting, spelling, and link issues in lesson files #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 20, 2025

Overview

This PR addresses formatting inconsistencies, spelling issues, and broken links across the lesson files in the repository. The changes follow a consistent style using lessons/01-intro-to-genai/README.md as the reference for good structure and formatting.

Changes Made

Fixed header formatting issues

  • Standardized main lesson titles to use Title Case (e.g., "Lesson 5: Talk to Your Data with RAG")
  • Standardized section headers across all lessons (Related Resources, Self-Study Resources, Knowledge Check)
  • Fixed title case in subheadings in the reference file and other lesson files
  • Removed trailing colons from headers where they don't belong

Fixed British English spelling to American English

  • Changed "colours" to "colors" in lessons/03-prompt-engineering/README.md
  • Scanned for other common British spellings but found no other instances

Fixed broken links

  • Fixed link in lessons/01-intro-to-genai/translations/README.zh-cn.md (corrected path to README.md for AI disclaimer)
  • Fixed link in lessons/02-first-ai-app/translations/README.zh-cn.md (corrected path to lessons/01-intro-to-genai)
  • Fixed link in lessons/03-prompt-engineering/translations/README.bn.md (updated sample app link)
  • Fixed link in lessons/05-rag/translations/README.zh-cn.md (corrected path to lessons/01-intro-to-genai)
  • Fixed image link in lessons/06-tool-calling/README.md (removed query parameter that was causing 404)

Fixed formatting in quiz files

  • Removed trailing colons from question headers (e.g., "### ❓ Question 1:" → "### ❓ Question 1")
  • Fixed formatting in solution quiz files for consistency

Testing

  • Verified all links now resolve correctly
  • Checked for consistent header formatting across lessons
  • Verified American English spelling is used throughout

Fixes #121.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cdn.fwupd.org
    • Triggering command: /usr/bin/fwupdmgr refresh (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits May 20, 2025 18:12
Co-authored-by: softchris <4598064+softchris@users.noreply.github.com>
Co-authored-by: softchris <4598064+softchris@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Check formatting, spelling and grammar Fix formatting, spelling, and link issues in lesson files May 20, 2025
@Copilot Copilot AI requested a review from softchris May 20, 2025 18:15
@softchris softchris removed their assignment May 20, 2025
Copy link
Collaborator

@softchris softchris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@softchris softchris assigned softchris and unassigned Copilot May 20, 2025
@softchris softchris marked this pull request as ready for review May 20, 2025 18:34
@softchris softchris merged commit fdc018d into main May 20, 2025
3 checks passed
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.

Check formatting, spelling and grammar
2 participants