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
