Skip to content

Minor documentation formatting and wording improvement in README#43342

Open
24ds1000054-code wants to merge 1 commit intogithub:mainfrom
24ds1000054-code:patch-1
Open

Minor documentation formatting and wording improvement in README#43342
24ds1000054-code wants to merge 1 commit intogithub:mainfrom
24ds1000054-code:patch-1

Conversation

@24ds1000054-code
Copy link

This PR makes two small improvements to the README:

• Removes trailing whitespace after a sentence
• Improves wording in one sentence for readability

No functional changes.

AI assistance was used only to help draft the wording, and the changes were verified manually.

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.

This PR makes two small improvements to the README:

• Removes trailing whitespace after a sentence
• Improves wording in one sentence for readability

No functional changes.

AI assistance was used only to help draft the wording,
and the changes were verified manually.
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 13, 2026
@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.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@jeffordsshannon-ops

This comment was marked as spam.

@tchadcool9-ctrl

This comment was marked as spam.

Fast677

This comment was marked as spam.

@Sharra-writes
Copy link
Contributor

Sharra-writes commented Mar 16, 2026

@24ds1000054-code Removing the trailing space is fine, if you want to, but changing the sentence structure erases the connection between repos syncing and content changes being reflected, which isn't an improvement. If you remove that part, I'll approve the PR.

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team Waiting on contributor and removed triage Do not begin working on this issue until triaged by the team labels Mar 16, 2026
Copy link

@smoovhogg12 smoovhogg12 left a comment

Choose a reason for hiding this comment

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

Good

Choose a reason for hiding this comment

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

Good work

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.

6 participants