Skip to content

reduce repetitive phrasing in About the REST API - #45469

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

reduce repetitive phrasing in About the REST API#45469
Anujakhatri wants to merge 1 commit into
github:mainfrom
Anujakhatri:patch-2

Conversation

@Anujakhatri

Copy link
Copy Markdown

Why:

Closes:

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

Reworded the three bullet intros under "Getting started with the
REST API" in content/rest/about-the-rest-api/about-the-rest-api.md.
The phrase "you may find it helpful to refer to" was repeated across
all three, making the section feel repetitive. Each intro now uses
different, more direct phrasing. Also tightened the closing paragraph
about webhooks and GitHub Apps for conciseness. No changes to links,
front matter, or the "Further reading" section.

Before:

If you are new to REST APIs, you may find it helpful to refer
to the Quickstart or Getting Started guide for an introduction.

If you are familiar with REST APIs but new to GitHub's REST
API, you may find it helpful to refer to the authentication
documentation.

If you are building scripts or applications that use the
REST API, you may find some of the following guides helpful.

After:

If you are new to REST APIs, start with the Quickstart or
Getting Started guide.

If you are familiar with REST APIs but new to GitHub's REST
API, see the authentication documentation.

If you are building scripts or applications that use the
REST API, the following guides can help.

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.

@welcome

welcome Bot commented Aug 11, 2026

Copy link
Copy Markdown

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 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/about-the-rest-api/about-the-rest-api.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 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi @Anujakhatri I agree with your general assessment and the changes you've proposed to the first 3 paragraphs, but not the 4th. If you're happy to revert that last change, I can get this merged for you. Thanks!

For a list of libraries to facilitate scripting with the REST API, see [AUTOTITLE](/rest/using-the-rest-api/libraries-for-the-rest-api).

If you are building scripts or applications that use the REST API, you might also be interested in using webhooks to get notified about events or a {% data variables.product.prodname_github_app %} to access resources on behalf of a user or in an organization. For more information, see [AUTOTITLE](/webhooks/about-webhooks) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app).
You might also use webhooks to get notified about events, or build a {% data variables.product.prodname_github_app %} to act on behalf of a user or organization. For more information, see [AUTOTITLE](/webhooks/about-webhooks) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is a matter of choice; I'd prefer to leave the original text here as some of the intended meaning is lost in the change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team Waiting on contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants