Skip to content

Improve getting started documentation - #243

Open
ernstleierzopf wants to merge 19 commits into
developmentfrom
docs/getting-started
Open

Improve getting started documentation#243
ernstleierzopf wants to merge 19 commits into
developmentfrom
docs/getting-started

Conversation

@ernstleierzopf

@ernstleierzopf ernstleierzopf commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Task

Fixes #241

Description

Greatly shortened the getting started page, while also listing all tasks that are accomplished by the new getting_started.sh script. New Users can quickly read the page and decide on using the script for an interactive walkthrough of DetectMate. Before that users can also simply look at an example output of the script before deciding.

How Has This Been Tested?

  • Manually tested with ./scripts/getting_started.sh and ./scripts/getting_started.sh -y.
  • Added new GitHub workflow that runs on each pull request.

Checklist

  • This Pull-Request goes to the development branch.
  • I have successfully run prek locally.
  • I have added tests to cover my changes.
  • I have linked the issue-id to the task-description.
  • I have performed a self-review of my own code.

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant