Skip to content

Commit db26bdb

Browse files
Trottdanielleadams
authored andcommitted
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 <[email protected]> Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 348707f commit db26bdb

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

doc/guides/doc-style-guide.md doc/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ For topics not covered here, refer to the [Microsoft Writing Style Guide][].
109109
[Use sentence-style capitalization for headings]: https://docs.microsoft.com/en-us/style-guide/scannable-content/headings#formatting-headings
110110
[Use serial commas]: https://docs.microsoft.com/en-us/style-guide/punctuation/commas
111111
[`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
113113
[info string]: https://github.github.com/gfm/#info-string
114114
[language]: https://github.com/highlightjs/highlight.js/blob/HEAD/SUPPORTED_LANGUAGES.md
115115
[plugin]: https://editorconfig.org/#download

doc/guides/contributing/pull-requests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ If you are modifying code, please be sure to run `make lint` (or
121121
code style guide.
122122

123123
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
125125
included in the API docs will also be checked when running `make lint` (or
126126
`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,
127127
add or change the appropriate YAML documentation. Use `REPLACEME` for the

0 commit comments

Comments
 (0)