Skip to content

Commit 53d7bd6

Browse files
trop[bot]erickzhao
andauthored
chore: emphasize documentation style guide (#45909)
docs: emphasize documentation style guide Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Erick Zhao <ezhao@slack-corp.com>
1 parent 6eb4932 commit 53d7bd6

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Contributors guide: https://github.com/electron/electron/blob/main/CONTRIBUTING.
1313
- [ ] PR description included and stakeholders cc'd
1414
- [ ] `npm test` passes
1515
- [ ] tests are [changed or added](https://github.com/electron/electron/blob/main/docs/development/testing.md)
16-
- [ ] relevant documentation, tutorials, templates and examples are changed or added
16+
- [ ] relevant API documentation, tutorials, and examples are updated and follow the [documentation style guide](https://github.com/electron/electron/blob/main/docs/development/style-guide.md)
1717
- [ ] [PR release notes](https://github.com/electron/clerk/blob/main/README.md) describe the change in a way relevant to app developers, and are [capitalized, punctuated, and past tense](https://github.com/electron/clerk/blob/main/README.md#examples).
1818

1919
#### Release Notes

docs/development/api-history-migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Verify that the Pull Request is correct and make a corresponding entry in the
6565
API History:
6666
6767
> [!NOTE]
68-
> Refer to the [API History section of `styleguide.md`](../styleguide.md#api-history)
68+
> Refer to the [API History section of `style-guide.md`](./style-guide.md#api-history)
6969
for information on how to create API History blocks.
7070
7171
`````markdown

docs/styleguide.md renamed to docs/development/style-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ required[, optional]
195195
More detailed information on each of the arguments is noted in an unordered list
196196
below the method. The type of argument is notated by either JavaScript primitives
197197
(e.g. `string`, `Promise`, or `Object`), a custom API structure like Electron's
198-
[`Cookie`](api/structures/cookie.md), or the wildcard `any`.
198+
[`Cookie`](../api/structures/cookie.md), or the wildcard `any`.
199199

200200
If the argument is of type `Array`, use `[]` shorthand with the type of value
201201
inside the array (for example,`any[]` or `string[]`).
@@ -290,7 +290,7 @@ The purpose of the API History block is to describe when/where/how/why an API wa
290290
Each API change listed in the block should include a link to the
291291
PR where that change was made along with an optional short description of the
292292
change. If applicable, include the [heading id](https://gist.github.com/asabaylus/3071099)
293-
for that change from the [breaking changes documentation](./breaking-changes.md).
293+
for that change from the [breaking changes documentation](../breaking-changes.md).
294294

295295
The [API History linting script][api-history-linting-script] (`lint:api-history`)
296296
validates API History blocks in the Electron documentation against the schema and

0 commit comments

Comments
 (0)