Skip to content

Conversation

@BlackDadd77
Copy link

@BlackDadd77 BlackDadd77 commented Nov 27, 2025

Refine the title and introduction for clarity on code block usage.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Refine the title and introduction for clarity on code block usage.
Copilot AI review requested due to automatic review settings November 27, 2025 23:10
@github-actions
Copy link
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 27, 2025
Copilot finished reviewing on behalf of BlackDadd77 November 27, 2025 23:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR attempts to enhance the title and introduction for the code blocks documentation section. However, the change introduces a critical issue that breaks the file's YAML frontmatter.

Key Changes:

  • Modified the opening YAML frontmatter delimiter on line 1

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -1,4 +1,4 @@
---
-and-highlighting-code-blocks.md---
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

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

The frontmatter YAML header is malformed. Line 1 should be --- (three hyphens only) to properly open the YAML frontmatter block. The current value -and-highlighting-code-blocks.md--- will break the page rendering.

Suggested change
-and-highlighting-code-blocks.md---
---

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant