Skip to content

release(v0.2.0): add document packet splitting, JSON export, and docs restructure#90

Merged
adiadd merged 16 commits intomainfrom
dev
Mar 16, 2026
Merged

release(v0.2.0): add document packet splitting, JSON export, and docs restructure#90
adiadd merged 16 commits intomainfrom
dev

Conversation

@adiadd
Copy link
Contributor

@adiadd adiadd commented Mar 16, 2026

Issue #, if available:

Closes #33, #56, #82, #86

Description of changes:

This release introduces two new features, a bug fix, and a major documentation overhaul:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

vawsgit and others added 16 commits February 13, 2026 13:37
Add Export Methods for StructuredModel Configuration
Fixing the issues refernced in Issue #33
* docs: restructure documentation with new sections and navigation

* docs: add dark/light mode theme toggle and site URL config

* docs: update code examples and installation requirements

* docs: update deployment section to reflect implemented workflow

* docs: add comparison engine architecture guide for contributors

* docs: restructure documentation with consolidated navigation

* docs: address PR review feedback — add KIE framing, architecture diagrams, sample outputs, SME calibration guide, and namespaced extras
* Adding in the docsplit metrics.
* Impementing 1:1 metrics porting
* Added a namespace for Stickler docsplit metrics
* Added tests.

* ruff linting

* Updating the packet split metrics to include the new metrics in addition to classical
* Updating the mkdocs UI
* Adding tests
* Adding docs.
* Updating with the new evaluation tooling

Changes were made to the tooling to support JSON based invocation.

* Adding an example for docsplit.

* resolving the remaining comments
* Fixing the docs for the page number clarity.
* Removing the extra init file.
* Adding a case to cover empty data frame.

* Removing an empty readme.
Adding init py file to a test directory.
Copilot AI review requested due to automatic review settings March 16, 2026 16:13
@github-actions
Copy link

🔒 Security Scan Results

ASH Security Scan Report

  • Report generated: 2026-03-16T16:17:04+00:00
  • Time since scan: 2 minutes

Scan Metadata

  • Project: ASH
  • Scan executed: 2026-03-16T16:14:57+00:00
  • ASH version: 3.1.2

Summary

Scanner Results

The table below shows findings by scanner, with status based on severity thresholds and dependencies:

  • Severity levels:
    • Suppressed (S): Findings that have been explicitly suppressed and don't affect scanner status
    • Critical (C): Highest severity findings that require immediate attention
    • High (H): Serious findings that should be addressed soon
    • Medium (M): Moderate risk findings
    • Low (L): Lower risk findings
    • Info (I): Informational findings with minimal risk
  • Duration (Time): Time taken by the scanner to complete its execution
  • Actionable: Number of findings at or above the threshold severity level that require attention
  • Result:
    • PASSED = No findings at or above threshold
    • FAILED = Findings at or above threshold
    • MISSING = Required dependencies not available
    • SKIPPED = Scanner explicitly disabled
    • ERROR = Scanner execution error
  • Threshold: The minimum severity level that will cause a scanner to fail
    • Thresholds: ALL, LOW, MEDIUM, HIGH, CRITICAL
    • Source: Values in parentheses indicate where the threshold is set:
      • global (global_settings section in the ASH_CONFIG used)
      • config (scanner config section in the ASH_CONFIG used)
      • scanner (default configuration in the plugin, if explicitly set)
  • Statistics calculation:
    • All statistics are calculated from the final aggregated SARIF report
    • Suppressed findings are counted separately and do not contribute to actionable findings
    • Scanner status is determined by comparing actionable findings to the threshold
Scanner Suppressed Critical High Medium Low Info Actionable Result Threshold
bandit 0 0 0 0 3242 0 0 PASSED MEDIUM (global)
cdk-nag 0 0 0 0 0 0 0 PASSED MEDIUM (global)
cfn-nag 0 0 0 0 0 0 0 MISSING MEDIUM (global)
checkov 0 1 0 0 0 0 1 SKIPPED MEDIUM (global)
detect-secrets 0 0 0 0 0 0 0 PASSED MEDIUM (global)
grype 0 0 0 0 0 0 0 MISSING MEDIUM (global)
npm-audit 0 0 0 0 0 0 0 PASSED MEDIUM (global)
opengrep 0 0 0 0 0 0 0 MISSING MEDIUM (global)
semgrep 0 0 0 0 0 0 0 PASSED MEDIUM (global)
syft 0 0 0 0 0 0 0 MISSING MEDIUM (global)

Top 1 Hotspots

Files with the highest number of security findings:

Finding Count File Location
1 .github/workflows/workflow.yml

Detailed Findings

Show 1 actionable findings

Finding 1: CKV2_GHA_1

  • Severity: HIGH
  • Scanner: checkov
  • Rule ID: CKV2_GHA_1
  • Location: .github/workflows/workflow.yml:11-12

Description:
Ensure top-level permissions are not set to write-all


Report generated by Automated Security Helper (ASH) at 2026-03-16T16:17:05+00:00

@adiadd adiadd requested review from sromoam and removed request for Copilot March 16, 2026 16:17
Copy link
Contributor

@sromoam sromoam left a comment

Choose a reason for hiding this comment

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

Can't wait to have these improvements!

@adiadd adiadd merged commit 1bbdaa9 into main Mar 16, 2026
14 checks passed
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.

3 participants