Skip to content

docs: align Wrangle README with Chances product format - #54

Merged
mikkokotila merged 1 commit into
masterfrom
codex/readme-product-home
Oct 2, 2026
Merged

mikkokotila merged 1 commit into
masterfrom
codex/readme-product-home

Conversation

@mikkokotila

Copy link
Copy Markdown
Contributor

Wrangle's README now follows the Chances product home format: centered Autonomio header, navigation, five live badges, capability and workflow tables, first preparation, retained evidence, boundaries, and contribution/support/security/citation/license sections.

The first example remains a readable CLI workflow with the same YAML protocol available in Python and to agents. Installation explicitly distinguishes the current 1.0 API from the historical 0.7 PyPI package. Badge links use Wrangle's own Best Practices project, Scorecard repository, PyPI package, documentation, and master CI.

The generated installed README stays in sync; its builder now also rewrites HTML documentation links to package-relative paths.

Validation: 13 distribution/manual tests passed with warnings as errors (including the executable README Python example); catalog consistency, Ruff, whitespace, and all local Markdown/HTML links and anchors passed. Wheel/sdist builds and strict Twine checks passed; distribution verification executed all eight shipped workflows and the console/module CLI from the installed wheel. Read-only agent review found no issues.

  • Native Polars expressions/plans perform transformations and data checks; engine behavior is unchanged.
  • Documentation change needs no new runtime tests; existing executable examples pass.
  • Generated manuals and examples are current; local checks above pass, required PR checks will run.
  • Sources and existing outputs remain protected; unresolved scientific choices still stop execution.

@mikkokotila
mikkokotila enabled auto-merge (squash) October 2, 2026 05:31

@bit-mis bit-mis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed: no blocking findings.

@bit-mis bit-mis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed: no blocking findings.

@bit-mis bit-mis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed: no blocking findings.

@mikkokotila
mikkokotila disabled auto-merge October 2, 2026 06:29
@mikkokotila
mikkokotila merged commit f971a91 into master Oct 2, 2026
10 checks passed
@mikkokotila
mikkokotila deleted the codex/readme-product-home branch October 2, 2026 06:29
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.

2 participants