Skip to content

Title: Improve clarity of intro paragraph on REST API Guides page Body: The intro paragraph on /rest/guides reuses the word "results" with two different meanings in the same sentence, making it harder to read. Proposing a small copy edit for clarity. - #45468

Closed
Anujakhatri wants to merge 1 commit into
github:mainfrom
Anujakhatri:patch-1

Conversation

@Anujakhatri

Copy link
Copy Markdown

Why:

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

Reworded the intro paragraph on the REST API Guides index page
(content/rest/guides/index.md) to remove a repeated use of the
word "results" and improve overall readability. Split one long
sentence into two shorter ones for scannability. No changes to
front matter, links, or the guides list.

Before:

This section of the documentation is intended to get you
up-and-running with real-world GitHub API applications. We'll
go over everything you need to know, from authentication to
results manipulation to integrating results with other apps.

After:

These guides walk you through building real-world applications
with the GitHub API, covering everything from authentication to
processing and displaying the data you retrieve.

Each guide includes a complete project, documented and available
in the public platform-samples repository.

Updated the introduction to the REST API guides for clarity and conciseness.
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Aug 11, 2026
@github-actions

Copy link
Copy Markdown
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
rest/guides/index.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17

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

🤖 This comment is automatically generated.

@subatoi

subatoi commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Hi again @Anujakhatri — I think this is too much of a personal choice, and we won't be accepting this particular change, but I've made a comment on your other PR towards getting that merged. Thank you!

@subatoi subatoi closed this Aug 11, 2026
@Anujakhatri
Anujakhatri deleted the patch-1 branch August 11, 2026 17:42
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.

2 participants