Skip to content

docs: add comprehensive getting started and testing guides#147

Merged
unclesp1d3r merged 3 commits intomainfrom
dosu/doc-update-146
Mar 8, 2026
Merged

docs: add comprehensive getting started and testing guides#147
unclesp1d3r merged 3 commits intomainfrom
dosu/doc-update-146

Conversation

@dosubot
Copy link
Contributor

@dosubot dosubot bot commented Mar 7, 2026

Update documentation for #146

Add two new documentation guides to help users get started with DaemonEye and understand testing practices. The Getting Started guide covers installation options, quick setup, basic configuration, rule creation, and common operations across Linux, macOS, and Windows. The Testing guide provides comprehensive testing strategies including unit tests, integration tests, end-to-end tests, performance testing, security testing, and CI/CD integration details. These guides serve as essential references for both new users and developers.

Generated by Dosu

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Mar 7, 2026
@mergify
Copy link
Contributor

mergify bot commented Mar 7, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🔴 CI must pass

This rule is failing.

All CI checks must pass. Release-plz PRs are exempt because they only bump versions and changelogs (code was already tested on main), and GITHUB_TOKEN-triggered force-pushes suppress CI.

  • check-success = coverage
  • check-success = quality
  • check-success = test
  • check-success = test-cross-platform (macos-15, macOS)
  • check-success = test-cross-platform (ubuntu-22.04, Linux)
  • check-success = test-cross-platform (windows-2022, Windows)

🟢 Do not merge outdated PRs

Wonderful, this rule succeeded.

Make sure PRs are within 3 commits of the base branch before merging

  • #commits-behind <= 3

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 7, 2026
@mergify
Copy link
Contributor

mergify bot commented Mar 7, 2026

🧪 CI Insights

Here's what we observed from your CI run for bf2aef2.

🟢 All jobs passed!

But CI Insights is watching 👀

Apply mdformat line wrapping to docs/src/testing.md and increase
criterion sample_size from 5 to 10 (the minimum required by
criterion 0.8.2) in two benchmark groups to prevent panics.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
@unclesp1d3r unclesp1d3r self-assigned this Mar 8, 2026
Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
@unclesp1d3r unclesp1d3r merged commit d89e622 into main Mar 8, 2026
5 of 11 checks passed
@unclesp1d3r unclesp1d3r deleted the dosu/doc-update-146 branch March 8, 2026 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant