Skip to content

docs: add comprehensive getting started guide#161

Merged
mergify[bot] merged 1 commit into
mainfrom
dosu/doc-update-160
Mar 7, 2026
Merged

docs: add comprehensive getting started guide#161
mergify[bot] merged 1 commit into
mainfrom
dosu/doc-update-160

Conversation

@dosubot
Copy link
Copy Markdown
Contributor

@dosubot dosubot Bot commented Mar 7, 2026

Update documentation for #160

Introduce a complete getting started guide for libmagic-rs covering installation, quick start tutorial, library usage patterns, CLI commands, and practical examples. This documentation provides users with step-by-step instructions for both library integration and command-line tool usage, including error handling best practices and common usage patterns for file type identification.

Generated by Dosu

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 7, 2026
@mergify
Copy link
Copy Markdown
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

Wonderful, this rule succeeded.

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-latest, macOS)
  • check-success = test-cross-platform (ubuntu-22.04, Linux)
  • check-success = test-cross-platform (ubuntu-latest, Linux)
  • check-success = test-cross-platform (windows-latest, Windows)

🟢 Do not merge outdated PRs

Wonderful, this rule succeeded.

Make sure PRs are within 10 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
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

@mergify mergify Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatically approved by Mergify

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Mar 7, 2026

🧪 CI Insights

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

🟢 All jobs passed!

But CI Insights is watching 👀

@mergify mergify Bot merged commit b545cb0 into main Mar 7, 2026
25 checks passed
@mergify mergify Bot deleted the dosu/doc-update-160 branch March 7, 2026 00:50
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:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants