docs: Improve README with typos, grammar, and idiomatic fixes #3642
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ahpook
changed the title
This is a copy-editing pass on the README doc with improvements for clarity, typo/usage, and idiomatic grammar fixes.
ahpook
force-pushed
the
ahpook-readme-tweaks
branch
from
2014c86 to
afdd99f
Compare
|
@ahpook, I think it will be ideal to add a linter workflow in addition to fixing these issues. |
Contributor
Author
|
@GuptaNavdeep1983 do you mean that I need to create a new linter workflow in order to get this merged? I don't know how to do that, I just copy-edited the text for clarity. |
Member
We would welcome a PR to add a linter. |
Member
|
Thansk for taking the time to improve the docs. I started last week also moving the docs to a docs webpage, instead of a giant README. The PR is still in draft. Changes here needs to be ported finally to that PR as well. But suggestions and feedback is welcome. See https://github.com/philips-labs/terraform-aws-github-runner/pull/3633 |
npalm
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a copy-editing pass on the README doc with improvements
for clarity, typo/usage, and idiomatic grammar fixes.