Revise introduction for REST API guides#44534
Conversation
Updated the introductory text for REST API documentation to improve clarity and conciseness.
There was a problem hiding this comment.
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.
| 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.. |
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 linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
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-samplesrepository.Documentation improvements:
content/rest/guides/index.mdto clarify the topics covered (authentication, scripting, manipulating results, and integration) and to emphasize that each tutorial includes a documented project in the publicplatform-samplesrepository.Updated the introductory text for REST API documentation to improve clarity and conciseness.Why:
https://github.com//pull/44507This pull request updates the introduction to the REST API guides in
content/rest/guides/index.mdto 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:
platform-samplesrepository, 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: