From b4ed1b76366bc05802acf22b1f5701cc4c0cd602 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 14 Feb 2023 20:30:28 +0530 Subject: [PATCH 01/18] Added new styleguide - grammer.md --- pages/docs/community/styleguide/grammar.md | 42 ++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 pages/docs/community/styleguide/grammar.md diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md new file mode 100644 index 00000000000..67e1b83e52f --- /dev/null +++ b/pages/docs/community/styleguide/grammar.md @@ -0,0 +1,42 @@ +# Grammar + +## Abbreviations and Acronyms + +When using an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. + +Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which in turn requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. + +Here are some examples of abbreviations: +-‘Event-driven architecture’ can be abbreviated as ‘EDA’ +- ‘Producer Consumer Model’ can be abbreviated as ‘PCM’ + +‘Abbreviations usually take the first few letters of a word and also end in a full-stop. On the other hand, acronyms are mostly formed from the first letter of each word in a phrase.’ - IELTS + +Here are some examples of acronyms: +- ‘Artificial Intelligence’ can be acronymized as ‘AI’ +- ‘Application Programming Interface’ can be acronymized as ‘API’ + + +## Active voice + +Prefer active voice over passive voice whenever possible. Active voice makes writing easier to read and understand. When combined with short sentences, it makes it easy to convey an idea to the reader. + +Passive: ‘The documentation is being read by Charlie.’ +Active: ‘Charlie is reading the documentation.’ + +## Capitalization + +Follow standard [capitalization rules](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for American English. Avoid using unnecessary capitalization. + +Here are some examples of when capitalization should be used: +- The first letter of any sentence should be capitalized +- Trademarked words that include capital letters +- Names of programming languages or frameworks + +## Spelling + +Prefer American English over its counterparts. For example, use 'color' instead of 'colour'. + +## Verb tense + +Stick with the present tense wherever possible. However, in some cases, using the future tense might be unavoidable. \ No newline at end of file From 0c8d1496755f96cc89da6675d38db9706189db6a Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 4 Apr 2023 11:56:58 +0530 Subject: [PATCH 02/18] Create _section.md --- pages/docs/community/styleguide/_section.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 pages/docs/community/styleguide/_section.md diff --git a/pages/docs/community/styleguide/_section.md b/pages/docs/community/styleguide/_section.md new file mode 100644 index 00000000000..8b137891791 --- /dev/null +++ b/pages/docs/community/styleguide/_section.md @@ -0,0 +1 @@ + From 0084dac5214864b34199a03553033dae94e49d2e Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 4 Apr 2023 11:58:33 +0530 Subject: [PATCH 03/18] Create _section.md --- pages/docs/community/_section.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 pages/docs/community/_section.md diff --git a/pages/docs/community/_section.md b/pages/docs/community/_section.md new file mode 100644 index 00000000000..8b137891791 --- /dev/null +++ b/pages/docs/community/_section.md @@ -0,0 +1 @@ + From 331843ff088f768b0a1d8604a1959ec74a9aabaa Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 4 Apr 2023 11:58:43 +0530 Subject: [PATCH 04/18] Create index.md --- pages/docs/community/index.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 pages/docs/community/index.md diff --git a/pages/docs/community/index.md b/pages/docs/community/index.md new file mode 100644 index 00000000000..8b137891791 --- /dev/null +++ b/pages/docs/community/index.md @@ -0,0 +1 @@ + From 4511ec071471c3d79080847dd16d8d09939fa130 Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 4 Apr 2023 11:59:48 +0530 Subject: [PATCH 05/18] Create index.md --- pages/docs/community/styleguide/index.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 pages/docs/community/styleguide/index.md diff --git a/pages/docs/community/styleguide/index.md b/pages/docs/community/styleguide/index.md new file mode 100644 index 00000000000..8b137891791 --- /dev/null +++ b/pages/docs/community/styleguide/index.md @@ -0,0 +1 @@ + From 9bb36cfc4298ed2db6abf9f883d6040267186f9b Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 11 Apr 2023 20:25:59 +0530 Subject: [PATCH 06/18] Update pages/docs/community/_section.md Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --- pages/docs/community/_section.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pages/docs/community/_section.md b/pages/docs/community/_section.md index 8b137891791..9487d4a7b07 100644 --- a/pages/docs/community/_section.md +++ b/pages/docs/community/_section.md @@ -1 +1,4 @@ - +--- +title: 'Community' +weight: 5 +--- From 7113f9c0738dd585396ddfe32974e250bb94f6bb Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 11 Apr 2023 20:26:34 +0530 Subject: [PATCH 07/18] Update pages/docs/community/styleguide/grammar.md Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --- pages/docs/community/styleguide/grammar.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index 67e1b83e52f..5244005bece 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -1,4 +1,9 @@ -# Grammar +--- +title: Grammar +description: This page explains how to use Grammar when writing docs +--- +#Grammar + ## Abbreviations and Acronyms From ce8f3d4d0ae65cc207e38a7e1f7580de0eb5c7b0 Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 11 Apr 2023 20:29:03 +0530 Subject: [PATCH 08/18] Delete _section.md --- pages/docs/community/styleguide/_section.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 pages/docs/community/styleguide/_section.md diff --git a/pages/docs/community/styleguide/_section.md b/pages/docs/community/styleguide/_section.md deleted file mode 100644 index 8b137891791..00000000000 --- a/pages/docs/community/styleguide/_section.md +++ /dev/null @@ -1 +0,0 @@ - From 368304014ae96f4a94dbaa61f7316d5fc332d71a Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Tue, 11 Apr 2023 20:29:12 +0530 Subject: [PATCH 09/18] Delete index.md --- pages/docs/community/styleguide/index.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 pages/docs/community/styleguide/index.md diff --git a/pages/docs/community/styleguide/index.md b/pages/docs/community/styleguide/index.md deleted file mode 100644 index 8b137891791..00000000000 --- a/pages/docs/community/styleguide/index.md +++ /dev/null @@ -1 +0,0 @@ - From 4982603729375aee3c4636eae9ecef739d8cbacb Mon Sep 17 00:00:00 2001 From: Arya Gupta Date: Wed, 12 Apr 2023 20:38:50 +0530 Subject: [PATCH 10/18] Update pages/docs/community/index.md Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --- pages/docs/community/index.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/pages/docs/community/index.md b/pages/docs/community/index.md index 8b137891791..e8a6835c7ac 100644 --- a/pages/docs/community/index.md +++ b/pages/docs/community/index.md @@ -1 +1,24 @@ +title: Overview +weight: 2 +--- +## Community: Guidelines and resources around community. + +Welcome to AsyncAPI **Community**! Our Community section documents the community guidelines and resources. + + + +## Contribute to the AsyncAPI Community section +Code isn't the only way to contribute to OSS; Dev Docs are a **huge** help that benefit the entire OSS ecosystem. At AsyncAPI, we value Doc contributions as much as every other type of contribution. ❤️ + +To get started as a Docs contributor: +1. Familiarize yourself with our [project's Contribution Guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). +2. Head over to our [AsyncAPI Docs Board](https://github.com/orgs/asyncapi/projects/12). +3. Pick an issue you would like to contribute to and leave a comment introducing yourself. This is also the perfect place to leave any questions you may have on how to get started. +4. If there is no work done in that Docs issue yet, feel free to open a PR and get started! + +### Docs contributor questions +Do you have a documentation contributor question and you're wondering how to tag me into a GitHub discussion or PR? Never fear! + +Tag me in your AsyncAPI Doc PRs or [GitHub Discussions](https://github.com/asyncapi/community/discussions/categories/docs) via my GitHub handle, [`alequetzalli`](https://github.com/alequetzalli) 🐙. + From 6aeec8d450b2b231ff9583229aa282807e35501a Mon Sep 17 00:00:00 2001 From: unknown Date: Sat, 10 Jun 2023 17:57:47 +0530 Subject: [PATCH 11/18] Incorporated feedback into the style guide --- pages/docs/community/styleguide/grammar.md | 39 +++++++++++++++++----- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index 5244005bece..6c7d8ecc6a1 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -1,27 +1,24 @@ --- title: Grammar -description: This page explains how to use Grammar when writing docs +description: This document provides grammar usage guidelines for clear and effective technical writing. --- -#Grammar +## Grammar ## Abbreviations and Acronyms When using an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. -Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which in turn requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. +Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which in turn requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Abbreviations or acronyms once defined in a document should be used consistently to ensure clarity and avoid confusion for readers. Here are some examples of abbreviations: -‘Event-driven architecture’ can be abbreviated as ‘EDA’ - ‘Producer Consumer Model’ can be abbreviated as ‘PCM’ -‘Abbreviations usually take the first few letters of a word and also end in a full-stop. On the other hand, acronyms are mostly formed from the first letter of each word in a phrase.’ - IELTS - Here are some examples of acronyms: - ‘Artificial Intelligence’ can be acronymized as ‘AI’ - ‘Application Programming Interface’ can be acronymized as ‘API’ - ## Active voice Prefer active voice over passive voice whenever possible. Active voice makes writing easier to read and understand. When combined with short sentences, it makes it easy to convey an idea to the reader. @@ -29,19 +26,43 @@ Prefer active voice over passive voice whenever possible. Active voice makes wri Passive: ‘The documentation is being read by Charlie.’ Active: ‘Charlie is reading the documentation.’ +Passive: ‘APIs are leveraged by developers to save time while building software.’ +Active: ‘Developers leverage APIs to save time while building software.’ + +Passive: ‘Clear instructions and explanations are provided for users by technical documentation.’ +Active: ‘Technical documentation provides clear instructions and explanations for users.’ + ## Capitalization -Follow standard [capitalization rules](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for American English. Avoid using unnecessary capitalization. +Follow standard capitalization rules for American English. Avoid using unnecessary capitalization. Here are some examples of when capitalization should be used: +- All proper nouns - The first letter of any sentence should be capitalized - Trademarked words that include capital letters - Names of programming languages or frameworks +- References within a document + +Never capitalize for emphasis. ## Spelling -Prefer American English over its counterparts. For example, use 'color' instead of 'colour'. +Prefer American English over its counterparts. + +A few examples: +- Use 'color' instead of 'colour'. +- Use 'analyze' instead of 'analyse'. +- Use 'skillful' instead of 'skilful'. ## Verb tense -Stick with the present tense wherever possible. However, in some cases, using the future tense might be unavoidable. \ No newline at end of file +Stick with the present tense wherever possible. However, in some cases, using the future tense might be unavoidable. The present tense is more appropriate when speaking about facts, while the future tense might be needed when referring to experiments or improvements that are yet to come. + +The present tense is more appropriate when speaking about facts. +‘An AsyncAPI document is a file that defines and annotates the different components of a specific Event-Driven API.’ + +Future tense might be needed when referring to experiments or improvements that are yet to come. +‘We will incorporate user feedback to address any problems in the documentation.’ + +Past tense is used while talking about events that have previously occurred: +‘Tutorials were added to the documentation as an entry point for new users.’ \ No newline at end of file From 1bc3f11c0bf17c26f95e0159820d3314d1daf5e2 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Mon, 12 Jun 2023 19:52:55 -0700 Subject: [PATCH 12/18] fixing community content bucket weight --- pages/docs/community/_section.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/_section.md b/pages/docs/community/_section.md index 9487d4a7b07..8c647775929 100644 --- a/pages/docs/community/_section.md +++ b/pages/docs/community/_section.md @@ -1,4 +1,4 @@ --- title: 'Community' -weight: 5 +weight: 6 --- From 2599ff8a92ac5ee13f9d505559fb36a2a7fbf4b9 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Mon, 12 Jun 2023 20:07:25 -0700 Subject: [PATCH 13/18] Another editorial round --- pages/docs/community/styleguide/grammar.md | 29 +++++++++++----------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index 6c7d8ecc6a1..6862980b2c6 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -5,23 +5,23 @@ description: This document provides grammar usage guidelines for clear and effec ## Grammar -## Abbreviations and Acronyms +## Abbreviations and acronyms -When using an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. +When you use an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. -Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which in turn requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Abbreviations or acronyms once defined in a document should be used consistently to ensure clarity and avoid confusion for readers. +Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Abbreviations or acronyms, once defined in a document, should be used consistently to ensure clarity and avoid confusion for readers. Here are some examples of abbreviations: --‘Event-driven architecture’ can be abbreviated as ‘EDA’ -- ‘Producer Consumer Model’ can be abbreviated as ‘PCM’ +- ‘Event-driven architecture’ can be abbreviated as ‘EDA’. +- ‘Producer Consumer Model’ can be abbreviated as ‘PCM’. Here are some examples of acronyms: -- ‘Artificial Intelligence’ can be acronymized as ‘AI’ -- ‘Application Programming Interface’ can be acronymized as ‘API’ +- ‘Artificial Intelligence’ can be acronymized as ‘AI’. +- ‘Application Programming Interface’ can be acronymized as ‘API’. ## Active voice -Prefer active voice over passive voice whenever possible. Active voice makes writing easier to read and understand. When combined with short sentences, it makes it easy to convey an idea to the reader. +Use active voice over passive voice whenever possible. Active voice makes writing easier to read and understand. When combined with short sentences, it makes it easy to convey an idea to the reader. Passive: ‘The documentation is being read by Charlie.’ Active: ‘Charlie is reading the documentation.’ @@ -34,16 +34,15 @@ Active: ‘Technical documentation provides clear instructions and explanations ## Capitalization -Follow standard capitalization rules for American English. Avoid using unnecessary capitalization. +Follow standard capitalization rules for American English. Avoid using unnecessary capitalization, and never capitalize for emphasis. Here are some examples of when capitalization should be used: -- All proper nouns -- The first letter of any sentence should be capitalized -- Trademarked words that include capital letters -- Names of programming languages or frameworks -- References within a document +- All proper nouns. +- The first letter of any sentence should be capitalized. +- Trademarked words that include capital letters. +- Names of programming languages or frameworks. +- References within a document. -Never capitalize for emphasis. ## Spelling From fc6ac28b0b8f01c406a58724677b9d572c2db6d4 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 13 Jun 2023 20:45:22 +0530 Subject: [PATCH 14/18] Added introduction to Grammar style guide --- pages/docs/community/styleguide/grammar.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index 6c7d8ecc6a1..0fac2f42a39 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -4,6 +4,7 @@ description: This document provides grammar usage guidelines for clear and effec --- ## Grammar +This style guide defines standards for AsyncAPI documentation for grammar across topics such as abbreviations and acronyms, active voice, capitalization, spelling, and verb tense. If you are a part of the AsyncAPI Slack, use the #13_docs channel for any queries. Please make sure to go through the style guide before contributing to AsyncAPI documentation. ## Abbreviations and Acronyms From 2e97c7f98084940d5aa827a72f213ab64107e8d7 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Thu, 15 Jun 2023 20:14:18 -0700 Subject: [PATCH 15/18] grammar improvements --- pages/docs/community/styleguide/grammar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index f63f8c76797..3d39c028c65 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -10,7 +10,7 @@ This style guide defines standards for AsyncAPI documentation for grammar across When you use an abbreviation or acronym for the first time, spell it out and include the shortest form in parentheses. -Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Abbreviations or acronyms, once defined in a document, should be used consistently to ensure clarity and avoid confusion for readers. +Abbreviations are meant to be used to save the reader’s time. They make your documentation look clean. However, using abbreviations may come with some downsides. Abbreviations add a layer of abstraction to text, which requires the reader to spend some mental energy to expand. Thus, it is best to add abbreviations in case of words that have been repeatedly used throughout your document. Once defined in a document, abbreviations or acronyms should be used consistently to ensure clarity and avoid confusion for readers Here are some examples of abbreviations: - ‘Event-driven architecture’ can be abbreviated as ‘EDA’. @@ -61,7 +61,7 @@ Stick with the present tense wherever possible. However, in some cases, using th The present tense is more appropriate when speaking about facts. ‘An AsyncAPI document is a file that defines and annotates the different components of a specific Event-Driven API.’ -Future tense might be needed when referring to experiments or improvements that are yet to come. +The future tense might be needed when referring to future enhancements, experiments, or planned improvements. ‘We will incorporate user feedback to address any problems in the documentation.’ Past tense is used while talking about events that have previously occurred: From 43596d89f45ebbab8639146b68cf3115197d477e Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Thu, 15 Jun 2023 20:15:09 -0700 Subject: [PATCH 16/18] remove slack channel mention --- pages/docs/community/styleguide/grammar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index 3d39c028c65..f9ea953af4d 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -4,7 +4,7 @@ description: This document provides grammar usage guidelines for clear and effec --- ## Grammar -This style guide defines standards for AsyncAPI documentation for grammar across topics such as abbreviations and acronyms, active voice, capitalization, spelling, and verb tense. If you are a part of the AsyncAPI Slack, use the #13_docs channel for any queries. Please make sure to go through the style guide before contributing to AsyncAPI documentation. +This style guide defines standards for AsyncAPI documentation for grammar across topics such as abbreviations and acronyms, active voice, capitalization, spelling, and verb tense. ## Abbreviations and acronyms From 769bfa3cfe50a3593a7664598d6953087e34e87e Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Thu, 15 Jun 2023 20:16:03 -0700 Subject: [PATCH 17/18] sentence fix --- pages/docs/community/styleguide/grammar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/styleguide/grammar.md index f9ea953af4d..3979dd3728f 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/styleguide/grammar.md @@ -4,7 +4,7 @@ description: This document provides grammar usage guidelines for clear and effec --- ## Grammar -This style guide defines standards for AsyncAPI documentation for grammar across topics such as abbreviations and acronyms, active voice, capitalization, spelling, and verb tense. +This document defines grammar standards for AsyncAPI documentation across abbreviations and acronyms, active voice, capitalization, spelling, and verb tense. ## Abbreviations and acronyms From ec1eadd1097ac98f4bc6dad6461d90ec902a658f Mon Sep 17 00:00:00 2001 From: unknown Date: Sat, 17 Jun 2023 00:09:33 +0530 Subject: [PATCH 18/18] fixed directory structure --- pages/docs/community/{styleguide => style-guide}/grammar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename pages/docs/community/{styleguide => style-guide}/grammar.md (99%) diff --git a/pages/docs/community/styleguide/grammar.md b/pages/docs/community/style-guide/grammar.md similarity index 99% rename from pages/docs/community/styleguide/grammar.md rename to pages/docs/community/style-guide/grammar.md index f63f8c76797..8a7a66837de 100644 --- a/pages/docs/community/styleguide/grammar.md +++ b/pages/docs/community/style-guide/grammar.md @@ -64,5 +64,5 @@ The present tense is more appropriate when speaking about facts. Future tense might be needed when referring to experiments or improvements that are yet to come. ‘We will incorporate user feedback to address any problems in the documentation.’ -Past tense is used while talking about events that have previously occurred: +Past tense is used while talking about events that have previously occurred. ‘Tutorials were added to the documentation as an entry point for new users.’ \ No newline at end of file