Skip to content

docs: real side-by-side in Verified parity section (0.2.2) - #17

Merged
warpedatom merged 1 commit into
mainfrom
docs/parity-comparison
Jul 21, 2026
Merged

docs: real side-by-side in Verified parity section (0.2.2)#17
warpedatom merged 1 commit into
mainfrom
docs/parity-comparison

Conversation

@warpedatom

@warpedatom warpedatom commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Update documentation to show accurate side-by-side IOC JSON outputs for OffsetScan and the PowerShell wrapper, and bump the crate version to 0.2.2.

Build:

  • Bump the crate version from 0.2.1 to 0.2.2 in Cargo.toml.

Documentation:

  • Rework the README "Verified parity" section to display real JSON outputs from offsetscan ioc and Get-OffsetIOC | ConvertTo-Json, clarifying that differences are only in serialization format.

@sourcery-ai

sourcery-ai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates documentation to show a true side‑by‑side parity example between the CLI and PowerShell engines, and bumps the crate version to 0.2.2 with a corresponding changelog entry. No functional code changes.

File-Level Changes

Change Details Files
Clarify and modernize the README "Verified parity" section with real, side‑by‑side JSON output from both engines.
  • Replace the previous stylized IOC example with two separate, realistic command examples: offsetscan ioc and `Get-OffsetIOC
ConvertTo-Json.</li><li>Show actual JSON output shapes for each engine (array vs object, /vs` path separators).
  • Explicitly state that all field values match and that differences are only in cosmetic serialization.
  • Document the 0.2.2 release as a documentation-only update and explain the parity example change.
    • Add a new 0.2.2 version section with a Documentation subsection.
    • Describe that the Verified parity example now uses actual tool output and clarifies serialization differences.
    • Note explicitly that there are no code changes in this release.
    CHANGELOG.md
    Bump crate version to 0.2.2 to align with the new documented release.
    • Update the package version from 0.2.1 to 0.2.2 in Cargo.toml.
    • Regenerate Cargo.lock to reflect the new version (no dependency changes indicated).
    Cargo.toml
    Cargo.lock

    Tips and commands

    Interacting with Sourcery

    • Trigger a new review: Comment @sourcery-ai review on the pull request.
    • Continue discussions: Reply directly to Sourcery's review comments.
    • Generate a GitHub issue from a review comment: Ask Sourcery to create an
      issue from a review comment by replying to it. You can also reply to a
      review comment with @sourcery-ai issue to create an issue from it.
    • Generate a pull request title: Write @sourcery-ai anywhere in the pull
      request title to generate a title at any time. You can also comment
      @sourcery-ai title on the pull request to (re-)generate the title at any time.
    • Generate a pull request summary: Write @sourcery-ai summary anywhere in
      the pull request body to generate a PR summary at any time exactly where you
      want it. You can also comment @sourcery-ai summary on the pull request to
      (re-)generate the summary at any time.
    • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
      request to (re-)generate the reviewer's guide at any time.
    • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
      pull request to resolve all Sourcery comments. Useful if you've already
      addressed all the comments and don't want to see them anymore.
    • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
      request to dismiss all existing Sourcery reviews. Especially useful if you
      want to start fresh with a new review - don't forget to comment
      @sourcery-ai review to trigger a new review!

    Customizing Your Experience

    Access your dashboard to:

    • Enable or disable review features such as the Sourcery-generated pull request
      summary, the reviewer's guide, and others.
    • Change the review language.
    • Add, remove or edit custom review instructions.
    • Adjust other review settings.

    Getting Help

    @sourcery-ai sourcery-ai Bot left a comment

    Copy link
    Copy Markdown
    Contributor

    Choose a reason for hiding this comment

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

    Hey - I've reviewed your changes and they look great!


    Sourcery is free for open source - if you like our reviews please consider sharing them ✨
    Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

    @warpedatom
    warpedatom merged commit a4006df into main Jul 21, 2026
    6 checks passed
    @warpedatom
    warpedatom deleted the docs/parity-comparison branch July 21, 2026 19:23
    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