docs: Add coding agent docs, SKILL.md#290
Open
Andreas Albert (AndreasAlbertQC) wants to merge 5 commits intomainfrom
Open
docs: Add coding agent docs, SKILL.md#290Andreas Albert (AndreasAlbertQC) wants to merge 5 commits intomainfrom
SKILL.md#290Andreas Albert (AndreasAlbertQC) wants to merge 5 commits intomainfrom
Conversation
github-actions
bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #290 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 54 56 +2
Lines 3125 3218 +93
=========================================
+ Hits 3125 3218 +93 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Andreas Albert (AndreasAlbertQC)
requested review from
Oliver Borchert (borchero) and
Daniel Elsner (delsner)
as code owners
Copilot started reviewing on behalf of
Andreas Albert (AndreasAlbertQC)
March 11, 2026 16:25
View session
There was a problem hiding this comment.
Pull request overview
Adds documentation aimed at helping users integrate dataframely with AI coding agents by introducing a new “coding agents” guide and a reusable SKILL.md skill file.
Changes:
- Add a new docs guide page describing how to use
dataframelywith coding agents. - Introduce
SKILL.mdintended to be consumed by agent skill frameworks. - Minor docs/build metadata adjustments (docs index, docs conf whitespace, pixi lock metadata).
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| pixi.toml | No functional change (whitespace-only). |
| pixi.lock | Adds pypi-prerelease-mode options metadata across environments. |
| docs/guides/index.md | Adds coding-agents to the guides toctree. |
| docs/guides/coding-agents.md | New guide on using dataframely with coding agents and referencing SKILL.md. |
| docs/conf.py | Removes stray whitespace line. |
| SKILL.md | New agent skill document with examples and conventions for using dataframely. |
You can also share your feedback on Copilot code review. Take the survey.
| ## Verifying results | ||
|
|
||
| `dataframely` supports you and your coding agent in writing unit tests for individual pieces of logic. One significant | ||
| bottle neck is the generation of appropriate test data. Check |
There was a problem hiding this comment.
Spelling: “bottle neck” should be “bottleneck”.
Suggested change
| bottle neck is the generation of appropriate test data. Check | |
| bottleneck is the generation of appropriate test data. Check |
Daniel Elsner (delsner)
approved these changes
Mar 24, 2026
Member
Daniel Elsner (delsner)
left a comment
Daniel Elsner (delsner)
left a comment
There was a problem hiding this comment.
Thanks, I think this is a good starting point. Just a few nits.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
We want to provide instructions for using
dataframelywith AI coding agents.Changes