Skip to content

docs: Update documentation and skill - #424

Draft
Moritz Potthoff (MoritzPotthoffQC) wants to merge 7 commits into
mainfrom
update-skill
Draft

Moritz Potthoff (MoritzPotthoffQC) wants to merge 7 commits into
mainfrom
update-skill

Conversation

@MoritzPotthoffQC

@MoritzPotthoffQC Moritz Potthoff (MoritzPotthoffQC) commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

Some portions of the docs and skill are outdated.

Changes

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 13, 2026
@codecov

codecov Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7f68841) to head (17bd7de).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #424   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           46        46           
  Lines         2587      2587           
=========================================
  Hits          2587      2587           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MoritzPotthoffQC Moritz Potthoff (MoritzPotthoffQC) changed the title docs: Update and improve skill docs: Update documentation skill Nov 13, 2026

Copilot AI 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.

🟡 Changes recommended

The quickstart example fails with a NameError because Polars is not imported before use, and the skill guidance incorrectly suggests that Collection.is_valid supports lazy=True.

2 open issues
What changed in this PR

This documentation-only PR updates Dataframely’s usage skill and guides to reflect the current public API.

Changes:

  • Clarifies lazy validation, uniqueness constraints, column descriptions, and collection sampling.
  • Corrects examples, error output, and documentation links.
  • Expands API reference coverage for existing public methods and classes.
File Description
skills/​SKILL.md Updates validation, collection, and sampling guidance.
docs/​guides/​quickstart.md Adds a grouped rule example and updates API usage.
docs/​guides/​migration/​v1-v2.md Replaces scan-method cross-references with inline code.
docs/​guides/​features/​sql-generation.md Clarifies SQL constraints and corrects table creation.
docs/​guides/​features/​primary-keys.md Documents independent column uniqueness.
docs/​guides/​features/​lazy-validation.md Explains current schema and collection lazy behavior.
docs/​guides/​features/​data-generation.md Corrects sampling guidance and collection examples.
docs/​guides/​features/​column-metadata.md Documents the column description parameter.
docs/​guides/​faq.md Updates uniqueness guidance and fixes a section link.
docs/​guides/​examples/​real-world.ipynb Refreshes recorded outputs and validation errors.
docs/​conf.py Removes the obsolete group-rules warning exception.
docs/​api/​schema/​conversion.rst Adds Schema.to_pydantic_model to the reference.
docs/​api/​misc/​index.rst Adds CollectionMember to the reference.
docs/​api/​filter_result/​failure_info.rst Adds FailureInfo.details to the reference.
docs/​api/​columns/​index.rst Adds the base Column class to the reference.
docs/​api/​collection/​metadata.rst Adds eager and lazy member inspection methods.

Review effort: Balanced

Comment thread docs/guides/quickstart.md Resolved
Comment thread skills/SKILL.md Resolved
@MoritzPotthoffQC Moritz Potthoff (MoritzPotthoffQC) changed the title docs: Update documentation skill docs: Update documentation and skill Nov 13, 2026

Copilot AI 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.

🟢 Approval recommended

No active review issues are reported for the documentation and skill-guidance updates.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

This branch has not been deployed

No deployments
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants