Skip to content

docs: harmonize grammar and style across book - #300

Merged
adulau merged 1 commit into
mainfrom
codex/review-grammar-and-style-of-misp-book
Mar 20, 2026
Merged

docs: harmonize grammar and style across book#300
adulau merged 1 commit into
mainfrom
codex/review-grammar-and-style-of-misp-book

Conversation

@adulau

@adulau adulau commented Mar 18, 2026

Copy link
Copy Markdown
Member

Motivation

  • Normalize grammar, capitalization, and phrasing across the book so the documentation reads consistently in American English.
  • Improve clarity of contributor-facing guidance and chapter introductions to reduce ambiguity for new contributors and translators.
  • Make common UI/procedural pages and examples easier to follow by standardizing terminology and formatting.

Description

  • Edited top-level landing and navigation files including README.md, SUMMARY.md, and CONTRIBUTING.md to standardize tone and capitalization.
  • Rewrote and clarified multiple chapter introductions and procedural pages such as USAGE.md, create-event-report/README.md, delegation/README.md, connectors/README.md, pymisp/README.md, updating-python/README.md, get-your-instance/README.md, modules/README.md, noticelists/README.md, and warninglists/README.md.
  • Cleaned glossary and style guidance in GLOSSARY.md, book-convention/README.md, and translation/README.md to align terminology and translation guidance.
  • Performed whitespace and formatting cleanups (tabs replaced, trailing spaces removed) across the edited files to improve diffs and build hygiene.

Testing

  • Ran git diff --check to detect whitespace and patch issues and fixed reported problems, which returned no errors.
  • Ran a Python script that verified there are no trailing whitespace characters or tab characters in the reviewed files (checked files listed in the PR), and it reported OK.
  • Reviewed diffs for the edited files (README.md, SUMMARY.md, CONTRIBUTING.md, GLOSSARY.md, USAGE.md, chapter README files) to ensure wording and formatting changes are consistent and do not alter technical instructions; no regressions were found.
  • All automated checks referenced above passed.

Codex Task

@adulau
adulau merged commit c932e56 into main Mar 20, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant