Skip to content

docs: Add coding agent docs, SKILL.md, and update copilot instructions#290

Merged
Oliver Borchert (borchero) merged 9 commits intomainfrom
2026-03-02_agent
Mar 31, 2026
Merged

docs: Add coding agent docs, SKILL.md, and update copilot instructions#290
Oliver Borchert (borchero) merged 9 commits intomainfrom
2026-03-02_agent

Conversation

@AndreasAlbertQC
Copy link
Copy Markdown
Collaborator

Motivation

We want to provide instructions for using dataframely with AI coding agents.

Changes

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ca50937) to head (f0413a1).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #290   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           56        56           
  Lines         3218      3218           
=========================================
  Hits          3218      3218           

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 dataframely with coding agents.
  • Introduce SKILL.md intended 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.

Copy link
Copy Markdown
Member

@delsner Daniel Elsner (delsner) left a comment

Choose a reason for hiding this comment

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

Thanks, I think this is a good starting point. Just a few nits.

@borchero Oliver Borchert (borchero) changed the title docs: Add coding agent docs, SKILL.md docs: Add coding agent docs, SKILL.md, and update copilot instructions Mar 31, 2026
@borchero Oliver Borchert (borchero) enabled auto-merge (squash) March 31, 2026 16:18
@borchero Oliver Borchert (borchero) merged commit c059946 into main Mar 31, 2026
34 checks passed
@borchero Oliver Borchert (borchero) deleted the 2026-03-02_agent branch March 31, 2026 16:35
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.

4 participants