Skip to content

Commit b45e6c4

Browse files
authored
Add a link to the 'Docs contributing guide' (#1088)
1 parent 1c0fc29 commit b45e6c4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pages/md-style-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: JSON Schema documentation style guide
33
---
44

5-
Welcome to JSON Schema! This guide is intended for project contributors and provides guidelines for the text-formatting conventions of our documentation. The purpose of this style guide is to create consistency throughout our documentation, so make sure to read and follow it carefully.
5+
Welcome to JSON Schema! This guide is intended for project contributors and provides guidelines for the text-formatting conventions of our documentation. The purpose of this style guide is to create consistency throughout our documentation, so make sure to read and follow it carefully. To learn about how to contribute to our documentation, see the [Docs contributing guide](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING-docs.md)
66

77
## Our preferred style guide
88

@@ -49,7 +49,7 @@ To ensure that code samples are easy to search, copy and paste, and adapt, inclu
4949

5050
## Titles and headings
5151

52-
Titles should be short and communicate the main idea of the document. For explanation or reference documents, the title should start with a noun, for example _Conditional subschemas_. When the document is a guide that includes steps to complete a task, such as a tutorial, the title should start with a verb, for example, _Structuring complex schemas_.
52+
Titles should be short and communicate the main idea of the document. For explanation or reference documents, the title should start with a noun phrase, for example, _Conditional subschemas_. When the document is a guide that includes steps to complete a task, such as a tutorial, the title should start with a bare infinitive, for example, _Structure complex schemas_. To learn more about headings and titles, see [_Headings and titles_](https://developers.google.com/style/text-formatting) of the Google developer documentation style guide.
5353

5454
Headings help readers scan the document and identify the parts that are relevant to them. Use headings, and subheadings when needed, that clearly describe the information they contain.
5555

0 commit comments

Comments
 (0)