Skip to content

docs: add comparison refresh checklist - #178

Merged
JohnnyWilson16 merged 2 commits into
FreshCode-Org:mainfrom
WilliamK112:agent/comparison-refresh-checklist
Aug 12, 2026
Merged

docs: add comparison refresh checklist#178
JohnnyWilson16 merged 2 commits into
FreshCode-Org:mainfrom
WilliamK112:agent/comparison-refresh-checklist

Conversation

@WilliamK112

Copy link
Copy Markdown
Contributor

Description

Adds an evidence-first refresh checklist for FreshData's comparison tables.

The checklist:

  • identifies primary documentation and release sources for pandas, PyJanitor, Great Expectations, ydata-profiling, cleanlab, and OpenRefine
  • defines consistent win / loss / tie / unproven evidence requirements
  • requires reproducible, like-for-like benchmark support for performance and quality claims
  • keeps docs/comparison.md as the detailed source of truth and guards the README from duplicating a large matrix
  • is linked from the comparison page and included in the contributor docs navigation

This follows the repository's current structure: the detailed tables now live in docs/comparison.md, rather than the README named in the original issue.

Fixes #2

Type of Change

  • Documentation / contributor workflow

Validation

  • mkdocs build --strict
  • ruff check .
  • git diff --check
  • verified all 12 linked official documentation and release URLs return HTTP 2xx

AI disclosure

I used an AI coding assistant to help inspect the current documentation structure, research primary upstream sources, draft the checklist, and validate the rendered docs. I reviewed the final content, links, and diff locally.

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@WilliamK112, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 20 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: db89e4c0-ccf1-47a1-922e-2e7accef7f31

📥 Commits

Reviewing files that changed from the base of the PR and between f5b360f and e09e020.

📒 Files selected for processing (3)
  • docs/community/comparison-refresh-checklist.md
  • docs/comparison.md
  • mkdocs.yml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@WilliamK112
WilliamK112 marked this pull request as ready for review August 12, 2026 11:55
@strix-security

Copy link
Copy Markdown
Contributor

Strix is installed on this repository, but we couldn't run this PR security review because this workspace's trial has ended. Add a card to resume code reviews here.

So far, Strix has reviewed 36 pull requests, surfaced 3 security issues (1 critical/high) and blocked 1 risky merge across this workspace.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 17d3ab3b45

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/community/comparison-refresh-checklist.md Outdated
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@JohnnyWilson16
JohnnyWilson16 merged commit 38f24c1 into FreshCode-Org:main Aug 12, 2026
16 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.

Add a comparison table refresh checklist

2 participants