Skip to content

Conversation

@RickCreator87
Copy link

Improve GitHub Advanced Security documentation for clarity, completeness, and accessibility

  • Simplified the introductory paragraph for better readability and added a brief explanation of GHAS.
  • Expanded feature descriptions with clear explanations and added links to relevant resources (e.g., CodeQL).
  • Replaced placeholder [AUTOTITLE] links with actual URLs to GitHub Plans and Billing documentation.
  • Added a detailed feature availability table with clear headers, icons, and a legend for accessibility.
  • Improved sentence structure and formatting for easier scanning and comprehension.
  • Added notes on licensing requirements and plan prerequisites with clearer guidance.
  • Ensured consistent terminology and style throughout the document.
  • Enhanced accessibility by replacing octicons with emoji equivalents and adding a legend.
  • Structured content with appropriate headings and bullet points for better navigation.

These improvements aim to help users better understand the capabilities, licensing, and usage of GitHub Advanced Security features, facilitating informed decision-making and smoother onboarding.

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.

Improve GitHub Advanced Security documentation for clarity, completeness, and accessibility

- Simplified the introductory paragraph for better readability and added a brief explanation of GHAS.
- Expanded feature descriptions with clear explanations and added links to relevant resources (e.g., CodeQL).
- Replaced placeholder [AUTOTITLE] links with actual URLs to GitHub Plans and Billing documentation.
- Added a detailed feature availability table with clear headers, icons, and a legend for accessibility.
- Improved sentence structure and formatting for easier scanning and comprehension.
- Added notes on licensing requirements and plan prerequisites with clearer guidance.
- Ensured consistent terminology and style throughout the document.
- Enhanced accessibility by replacing octicons with emoji equivalents and adding a legend.
- Structured content with appropriate headings and bullet points for better navigation.

These improvements aim to help users better understand the capabilities, licensing, and usage of GitHub Advanced Security features, facilitating informed decision-making and smoother onboarding.
@welcome
Copy link

welcome bot commented Nov 18, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 18, 2025
@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/learning-about-github/about-github-advanced-security.md fpt
ghec
ghes@ 3.18 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.18 3.17 3.16 3.15 3.14

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

🤖 This comment is automatically generated.

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