Commit db26bdb
doc: move style guide to findable location
Move the style guide to doc/README.md so people might find it. The
current location is easily overlooked, as is evidenced by
#41025
PR-URL: #41119
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 348707f commit db26bdb
2 files changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -109,7 +109,7 @@ For topics not covered here, refer to the [Microsoft Writing Style Guide][]. | |||
| 109 | 109 | [Use sentence-style capitalization for headings]: https://docs.microsoft.com/en-us/style-guide/scannable-content/headings#formatting-headings | |
| 110 | 110 | [Use serial commas]: https://docs.microsoft.com/en-us/style-guide/punctuation/commas | |
| 111 | 111 | [`remark-preset-lint-node`]: https://github.com/nodejs/remark-preset-lint-node | |
| 112 | - [doctools README]: ../../tools/doc/README.md | ||
| 112 | + [doctools README]: ../tools/doc/README.md | ||
| 113 | 113 | [info string]: https://github.github.com/gfm/#info-string | |
| 114 | 114 | [language]: https://github.com/highlightjs/highlight.js/blob/HEAD/SUPPORTED_LANGUAGES.md | |
| 115 | 115 | [plugin]: https://editorconfig.org/#download | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -121,7 +121,7 @@ If you are modifying code, please be sure to run `make lint` (or | |||
| 121 | 121 | code style guide. | |
| 122 | 122 | ||
| 123 | 123 | Any documentation you write (including code comments and API documentation) | |
| 124 | - should follow the [Style Guide](../doc-style-guide.md). Code samples | ||
| 124 | + should follow the [Style Guide](../../README.md). Code samples | ||
| 125 | 125 | included in the API docs will also be checked when running `make lint` (or | |
| 126 | 126 | `vcbuild.bat lint` on Windows). If you are adding to or deprecating an API, | |
| 127 | 127 | add or change the appropriate YAML documentation. Use `REPLACEME` for the | |
0 commit comments