Skip to content

Revise introduction for REST API guides#44534

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

Revise introduction for REST API guides#44534
jmwilson2019 wants to merge 1 commit into
github:mainfrom
jmwilson2019:patch-1

Conversation

@jmwilson2019
Copy link
Copy Markdown

This pull request updates the introduction to the REST API guides to clarify the scope and resources provided. The revised text emphasizes practical coverage of authentication, scripting, result manipulation, and integration, and highlights that each tutorial includes a documented project in the public platform-samples repository.

Documentation improvements:

  • Updated the introductory paragraph in content/rest/guides/index.md to clarify the topics covered (authentication, scripting, manipulating results, and integration) and to emphasize that each tutorial includes a documented project in the public platform-samples repository.Updated the introductory text for REST API documentation to improve clarity and conciseness.

Why:

https://github.com//pull/44507

This pull request updates the introduction to the REST API guides in content/rest/guides/index.md to clarify the scope and resources available for each tutorial. The main focus is on improving the onboarding experience for users of the REST API documentation.

Documentation improvements:

  • Clarified that the guides help users get up and running with real-world REST API applications, specifying topics like authentication, scripting, manipulating results, and integration with other apps.
  • Added that each tutorial includes a project saved and documented in the public platform-samples repository, making it easier for users to find and reference example projects.
    Closes:

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

first person voice/ "We'll"

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.

Updated the introductory text for REST API documentation to improve clarity and conciseness.
Copilot AI review requested due to automatic review settings June 1, 2026 02:10
Copy link
Copy Markdown
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

Note

Copilot was unable to run its full agentic suite in this review.

Updates the introductory text on the REST API guides index page for clarity and concision.

Changes:

  • Rewrites the intro paragraph to mention REST API guides and topics covered.
  • Adds a sentence about each tutorial including a documented project in platform-samples.

Comment on lines +24 to 26
Each tutorial includes a project saved and documented in the public platform-samples repository..
Every tutorial will include a project, and each project will be saved and documented in our public
[platform-samples](https://github.com/github/platform-samples) repository.
This section of the documentation is intended to get you up-and-running with
real-world {% data variables.product.github %} API applications. We'll go over everything you need to know, from authentication to results manipulation to integrating results with other apps.
This section of the documentation helps you get up and running with real-world {% data variables.product.github %} REST API applications. The guides cover authentication, scripting, manipulating results, and integrating with other apps.
Each tutorial includes a project saved and documented in the public platform-samples repository..
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

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 3.16
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17 3.16

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 Jun 1, 2026
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