From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 00/11] doc: improve contributing documentation clarity and style
Date: Wed, 14 Jan 2026 14:54:04 -0800 [thread overview]
Message-ID: <20260114225555.127448-1-stephen@networkplumber.org> (raw)
This patch series improves the readability and consistency of the DPDK
contributing documentation. The changes focus on editorial improvements
without altering any technical content or policies.
Initial work on this was done by the tech writer (Nandini)
but this is follow up using AI to get broader coverage.
The primary improvements across this series include:
- Converting passive voice to active voice for clearer, more direct prose
- Using imperative mood for guidelines and instructions
- Removing redundant phrases ("Please note that", "It is recommended that", etc.)
- Simplifying wordy constructions
- Fixing grammar, punctuation, and typos
- Improving consistency in terminology
The first patch fixes specific issues in the design guide, including
correcting "executive environment" to "execution environment" throughout.
The remaining patches systematically improve each contributing guide
document.
These changes make the documentation more accessible to new contributors
and align with modern technical writing best practices.
Stephen Hemminger (11):
doc: correct grammar and typos in design guide
doc: improve ABI policy documentation style
doc: improve coding style guide readability
doc: improve documentation guidelines style
doc: improve Linux uAPI header documentation
doc: improve new driver guide readability
doc: improve new library guide style
doc: improve patch submission guide readability
doc: improve stable releases documentation
doc: improve unit test guide readability
doc: improve vulnerability process documentation
doc/guides/contributing/abi_policy.rst | 194 +++++-----
doc/guides/contributing/coding_style.rst | 20 +-
doc/guides/contributing/design.rst | 71 ++--
doc/guides/contributing/documentation.rst | 6 +-
doc/guides/contributing/linux_uapi.rst | 40 +-
doc/guides/contributing/new_driver.rst | 62 ++--
doc/guides/contributing/new_library.rst | 20 +-
doc/guides/contributing/patches.rst | 434 +++++++++++-----------
doc/guides/contributing/stable.rst | 147 +++-----
doc/guides/contributing/unit_test.rst | 113 +++---
doc/guides/contributing/vulnerability.rst | 140 ++++---
11 files changed, 609 insertions(+), 638 deletions(-)
--
2.51.0
next reply other threads:[~2026-01-14 22:56 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-14 22:54 Stephen Hemminger [this message]
2026-01-14 22:54 ` [PATCH 01/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-14 22:54 ` [PATCH 02/11] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 03/11] doc: improve coding style guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 04/11] doc: improve documentation guidelines style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 05/11] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 06/11] doc: improve new driver guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 07/11] doc: improve new library guide style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 08/11] doc: improve patch submission guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 09/11] doc: improve stable releases documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 10/11] doc: improve unit test guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 11/11] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 00/12] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 01/12] doc: correct grammar and typos in design guide Stephen Hemminger
2026-03-31 22:41 ` Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 02/12] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 03/12] doc: improve coding style guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 04/12] doc: improve documentation guidelines style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 05/12] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 06/12] doc: improve new driver guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 07/12] doc: improve new library guide style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 08/12] doc: improve patch submission guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 09/12] doc: improve stable releases documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 10/12] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 11/12] doc: improve unit test guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 12/12] doc: fix grammar and style in ABI versioning guide Stephen Hemminger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260114225555.127448-1-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox