From 9d7a932019b323909b507d3cd0f1f77c1fe0cf8a Mon Sep 17 00:00:00 2001 From: Dhruva Kumar Date: Mon, 29 Jun 2026 11:27:08 +0530 Subject: [PATCH 1/3] docs: fix minor grammar mistakes in contributing guide --- source/contribute.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/contribute.rst b/source/contribute.rst index f512dd30d..478312f76 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -33,7 +33,7 @@ Documentation types This project consists of four distinct documentation types with specific purposes. The project aspires to follow the `Diátaxis process`_ -for creating quality documentation. When proposing new additions to the project please pick the +for creating quality documentation. When proposing new additions to the project, please pick the appropriate documentation type. .. _Diátaxis process: https://diataxis.fr/ @@ -103,7 +103,7 @@ If you are not familiar with reStructuredText (RST) syntax, please read `this gu before translating on Weblate. **Do not translate the text in reference directly** - When translating the text in reference, please do not translate them directly. + When translating text in reference, please do not translate it directly. | Wrong: Translate the following text directly: @@ -145,7 +145,7 @@ To build the guide, run the following shell command in the project's root folder After the process has completed you can find the HTML output in the ``./build/html`` directory. You can open the ``index.html`` file to view the -guide in web browser, but it's recommended to serve the guide using an HTTP +guide in a web browser, but it's recommended to serve the guide using an HTTP server. You can build the guide and serve it via an HTTP server using the following @@ -188,7 +188,7 @@ Scope The guide is meant to answer questions and solve problems with accurate and focused recommendations. -The guide isn't meant to be comprehensive and it's not meant to replace +The guide isn't meant to be comprehensive, and it's not meant to replace individual projects' documentation. For example, pip has dozens of commands, options, and settings. The pip documentation describes each of them in detail, while this guide describes only the parts of pip that are needed to complete the From 6e36a94ec2b6d4f58d3f7aa504d05945254fb736 Mon Sep 17 00:00:00 2001 From: Alyssa Coghlan Date: Tue, 11 Aug 2026 20:37:32 +1000 Subject: [PATCH 2/3] Apply suggestion from @ncoghlan --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 478312f76..170eabf7d 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -188,7 +188,7 @@ Scope The guide is meant to answer questions and solve problems with accurate and focused recommendations. -The guide isn't meant to be comprehensive, and it's not meant to replace +The guide isn't meant to be comprehensive and it's not meant to replace individual projects' documentation. For example, pip has dozens of commands, options, and settings. The pip documentation describes each of them in detail, while this guide describes only the parts of pip that are needed to complete the From 9480a0434a2db1429f898f99b151305141900bbe Mon Sep 17 00:00:00 2001 From: Alyssa Coghlan Date: Tue, 11 Aug 2026 20:39:06 +1000 Subject: [PATCH 3/3] Apply suggestion from @ncoghlan --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 170eabf7d..76c6516bd 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -103,7 +103,7 @@ If you are not familiar with reStructuredText (RST) syntax, please read `this gu before translating on Weblate. **Do not translate the text in reference directly** - When translating text in reference, please do not translate it directly. + When translating the text in a reference, please do not translate it directly. | Wrong: Translate the following text directly: