docs: fix language, casing, and formatting across markdown files#1544
Open
kranthipoturaju wants to merge 1 commit intoactions:mainfrom
Open
docs: fix language, casing, and formatting across markdown files#1544kranthipoturaju wants to merge 1 commit intoactions:mainfrom
kranthipoturaju wants to merge 1 commit intoactions:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Documentation-only PR to improve consistency and readability across the repo’s Markdown files (proper noun casing, grammar, heading hierarchy, and link formatting), without changing action behavior.
Changes:
- Standardized terminology/casing (e.g., Node.js, JavaScript, YAML; section heading casing).
- Fixed assorted grammar/punctuation issues and improved formatting (including some heading hierarchy adjustments in ADRs).
- Converted raw URLs to Markdown links and made minor template/readme text corrections.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adjusts breaking-change heading casing and improves wording/casing in multiple documentation sentences and examples. |
| docs/contributors.md | Cleans up wording, punctuation, and minor formatting in contributor guidance. |
| docs/advanced-usage.md | Improves grammar/punctuation and standardizes step naming/casing in examples and guidance. |
| docs/adrs/0001-support-caching-deps-for-monorepos.md | Fixes ADR numbering/title formatting and improves wording/casing in the proposal section. |
| docs/adrs/0000-caching-dependencies.md | Adjusts ADR heading hierarchy and corrects wording/grammar in multiple sections. |
| CODE_OF_CONDUCT.md | Wraps raw URLs as proper Markdown links. |
| .github/ISSUE_TEMPLATE/bug_report.md | Updates HTML comment formatting consistency in the issue template. |
| tests/README.md | Fixes wording and corrects the .tool-versions filename reference for test data docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## RC versions | ||
|
|
||
| You can use specify a rc version to download it from https://nodejs.org/download/rc. | ||
| You can use specify a RC version to download it from https://nodejs.org/download/rc. |
| @@ -1,10 +1,10 @@ | |||
| # 0. Support caching dependencies for mono repos | |||
| # 1. Support caching dependencies for mono repos | |||
| `current`/`latest`/`node` always resolve to the latest [dist version](https://nodejs.org/dist/index.json). | ||
| That version is then downloaded from actions/node-versions if possible, or directly from Node.js if not. | ||
| Since it will not be cached always, there is possibility of hitting rate limit when downloading from dist | ||
| Since it will not always be cached, there is a possibility of hitting a rate limit when downloading from dist |
| ## Using `setup-node` on GHES | ||
|
|
||
| `setup-node` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Nodejs distributions, `setup-node` downloads distributions from [`actions/node-versions`](https://github.com/actions/node-versions) on github.com (outside of the appliance). These calls to `actions/node-versions` are made via unauthenticated requests, which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If more requests are made within the time frame, then you will start to see rate-limit errors during downloading that looks like: `##[error]API rate limit exceeded for...`. After that error the action will try to download versions directly from the official site, but it also can have rate limit so it's better to put token. | ||
| `setup-node` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Node.js distributions, `setup-node` downloads distributions from [`actions/node-versions`](https://github.com/actions/node-versions) on github.com (outside of the appliance). These calls to `actions/node-versions` are made via unauthenticated requests, which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If more requests are made within the time frame, then you will start to see rate-limit errors during downloading that looks like: `##[error]API rate limit exceeded for...`. After that error the action will try to download versions directly from the official site, but it also can have rate limit so it's better to put token. |
| @@ -16,23 +16,23 @@ Integration of caching functionality into `actions/setup-node` action will bring | |||
| We will add support for NPM and Yarn dependencies caching. | |||
Comment on lines
31
to
33
| - Npm (retrieved via `npm config get cache`) | ||
| - Yarn 1 (retrieved via `yarn cache dir`) | ||
| - Yarn 2 (retrieved via `yarn config get cacheFolder`) |
|
|
||
| # Example of real use-cases | ||
| ## Example of real use cases | ||
| Npm package manager: |
| ### Yarn2 configuration | ||
| Yarn2 ignores both .npmrc and .yarnrc files created by the action, so before installing dependencies from the private repo it is necessary either to create or to modify existing yarnrc.yml file with `yarn config set` commands. | ||
| ### Yarn 2 configuration | ||
| Yarn 2 ignores both `.npmrc` and `.yarnrc` files created by the action, so before installing dependencies from the private repo it is necessary either to create or to modify an existing `yarnrc.yml` file with `yarn config set` commands. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes language, casing, and formatting issues across all Markdown documentation files. No content, behavior, or feature descriptions were changed — only presentation and correctness.
Changes
Nodejs→Node.js,javascript→JavaScript,Npm→npm,Yaml→YAML,Yarn2→Yarn 2,V6/V5→v6/v5in section headings,node20/node24→Node.js 20/Node.js 24get affect→take effectthere is possibility→there is a possibilitythe action use→the action usesadvice→advisethrow error if no one is found→throw an error if none is foundthe same approach like→the same approach asit you want→if you wantto review pull request→to review pull requeststo answer to→to answerHere the list→Here is the listhis opinion/his request→their opinion/their request0000-caching-dependencies.mdfrom H1 to H2 for correct hierarchy; fixed ADR0001title number from0.to1.;mono repos→monorepos;Yaml examples→YAML examplesCODE_OF_CONDUCT.mdas proper Markdown links-->→--->) inbug_report.md.tools-versions→.tool-versionsSetup nodestep label toSetup Node.jsacrossREADME.mdanddocs/advanced-usage.mdOfficial: Build→Official build, etc.)Motivation
The documentation contained accumulated inconsistencies in proper noun casing, minor grammatical errors, and structural issues (heading levels, raw URLs). These erode reader confidence and can cause confusion — especially the
Node.js/Nodejsinconsistency, which appears in code comments that users copy into their workflows.Impact
Testing
Documentation changes only. No build or runtime validation required.
Notes
Related issue:
No issue is created as the change is related to documentation improvement only.
Check list: