Skip to content

docs: improve README wording and getting started instructions #4226

Description

@Samuel25-hub

Description

I noticed a few small documentation issues in the README that could make the initial setup and contribution workflow clearer for new users and contributors.

Proposed improvements

  1. Fix the wording:

    • Issue: The is a collection of attack data.
    • Should be: "This is a collection of attack data.
  2. Standardize terminology:

    • Issue: "pre-requisite"
    • Should be: "prerequisite"
  3. Improve capitalization and punctuation in the Getting Started instructions.

  4. Clarify the distinction between the "Getting Started" and "Quick Start" sections so new contributors can more easily understand the setup and content-development workflow.

These would be documentation-only changes and would not modify any detection logic or security content.

I would be happy to submit a documentation PR addressing these items if this would be useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions