Skip to content

Update GitHub language support article with footnotes and improved note formatting #38633

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 5 commits into from
Jun 2, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 30, 2025

Fixes: https://github.com/github/docs-content/issues/14119

This PR makes several formatting improvements to the "GitHub language support" article:

Changes made

  1. Added footnote references to PHP, Rust, and Scala entries in the core languages table
  2. Reformatted the Note section below the table:
    • Removed bullet list formatting to make it a standard paragraph
    • Removed unnecessary bullets from all paragraphs
  3. Moved the information about PHP, Rust, and Scala to a proper Markdown footnote at the bottom of the document
  4. Enhanced the footnote text to clarify that these languages "are supported for code scanning by third-party actions, but not by {% data variables.product.prodname_codeql %}"

These changes improve readability while maintaining the proper relationship between the language entries in the table and their supporting information in the footnote.

Before and After

Before: The information about PHP, Rust, and Scala support was presented as a bulleted item in a note block.

After: This information is now properly linked as a footnote reference from each language name in the table, with the full explanation provided in a footnote at the bottom of the article.

This approach makes the relationship between the languages and the limitation more explicit, while keeping the main table clean and the note section focused on general information.


💡 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 Copilot AI changed the title [WIP] Update language support table: add footnote references and correct Note formatting Update GitHub language support article with footnotes and improved note formatting May 30, 2025
@Copilot Copilot AI requested a review from hubwriter May 30, 2025 16:04
Copilot finished work on behalf of hubwriter May 30, 2025 16:04
@hubwriter hubwriter marked this pull request as ready for review June 2, 2025 13:19
@Copilot Copilot AI review requested due to automatic review settings June 2, 2025 13:19
Copy link
Contributor

@Copilot 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 enhances the “GitHub language support” article by moving PHP, Rust, and Scala support notes into a footnote, cleaning up note formatting, and clarifying CodeQL limitations.

  • Added [^1] footnote markers to PHP, Rust, and Scala entries
  • Reformatted the NOTE block into plain paragraphs, removing list markers
  • Introduced a Markdown footnote explaining third-party action support and CodeQL exclusion
Comments suppressed due to low confidence (1)

content/get-started/learning-about-github/github-language-support.md:45

  • The blockquote marker (>) is placed after the Liquid tag, so it won’t render as a proper blockquote. Move the > to the start of the line, e.g., > {% ifversion fpt or ghec %} ....
{% ifversion fpt or ghec %}> The language support for {% data variables.product.prodname_copilot %} varies depending on the volume and diversity of training data for that language.{% endif %}

Copy link
Contributor

github-actions bot commented Jun 2, 2025

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/learning-about-github/github-language-support.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13

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

🤖 This comment is automatically generated.

@hubwriter
Copy link
Contributor

Copilot didn't realise the reusables were table rows, so you can't just stick a footnote superscript at the end of one. I've corrected this by putting the superscripts within the reusables.

Preview:
image

Copy link
Contributor Author

Copilot AI commented Jun 2, 2025

Copilot didn't realise the reusables were table rows, so you can't just stick a footnote superscript at the end of one. I've corrected this by putting the superscripts within the reusables.

Preview...

Thanks for the correction! You're absolutely right - since the table uses reusable components, the footnote superscripts need to be placed within the reusables themselves rather than after the include statements. The fix in commit c3094d0 properly places the [^1] references in the "Code scanning" column within each reusable file.

Copilot finished work on behalf of hubwriter June 2, 2025 14:07
@hubwriter hubwriter enabled auto-merge June 2, 2025 15:49
@hubwriter hubwriter added this pull request to the merge queue Jun 2, 2025
Merged via the queue into main with commit 75bf566 Jun 2, 2025
42 checks passed
@hubwriter hubwriter deleted the copilot/fix-732df555-77d5-46d3-9f9f-6593b98b2695 branch June 2, 2025 16:04
Copy link
Contributor

github-actions bot commented Jun 2, 2025

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

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.

3 participants