Skip to content

Document agents.md and skills features in copilot#557

Open
VellummyilumVinoth wants to merge 1 commit into
wso2:mainfrom
VellummyilumVinoth:add-agents.md-doc
Open

Document agents.md and skills features in copilot#557
VellummyilumVinoth wants to merge 1 commit into
wso2:mainfrom
VellummyilumVinoth:add-agents.md-doc

Conversation

@VellummyilumVinoth

@VellummyilumVinoth VellummyilumVinoth commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add Project instructions section to Copilot Capabilities — explains the AGENTS.md file and how to create or edit it from the Settings panel.
  • Add Skills section with three subsections: Manage skills, Add your own skill, and How Copilot uses skills.
  • Rename /datamap command → /data-map skill across ai-mapping.md, mapping-capabilities.md, and datamapper-editor.md.
  • Add four new screenshots: agents-md-settings-row.png, skills-manager-panel.png, add-skill-modal.png, enable-skill-prompt.png.

It addresses: wso2/product-integrator#1743, #537

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Added guidance on project instructions and reusable skills for Copilot workflows.
    • Clarified how to enable, organize, and create/import skills.
    • Updated AI data mapping and editor docs to use the new /data-map command.
    • Refreshed related visuals and wording in the mapping walkthroughs.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Added Copilot documentation for project instructions and skills, and standardized data-mapper documentation examples to use /data-map instead of /datamap.

Changes

Copilot documentation updates

Layer / File(s) Summary
Project instructions and skills
en/docs/develop/copilot/overview.md
Added guidance for workspace instructions via AGENTS.md and documented Copilot skills, including grouping, enablement, and custom skill handling.
Data-map command references
en/docs/develop/copilot/overview.md, en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md, en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md, en/docs/develop/understand-ide/editors/datamapper-editor.md
Replaced /datamap with /data-map in the slash-command list and data-mapper workflow examples, while keeping the described mapping flow unchanged.

Sequence Diagram(s)

None

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • MaryamZi
  • NipunaRanasinghe
  • rosensilva

Poem

A bunny hops through docs so bright,
With /data-map now set just right.
AGENTS.md guides the way,
Skills and commands join the play,
And mapping hops along in light. 🐇

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description fills only Summary and issue links; most required sections remain as template placeholders. Complete the template sections with actual content or explicit N/A entries for goals, approach, docs, tests, security, and other applicable fields.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR's main change: documenting AGENTS.md and Copilot skills.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@VellummyilumVinoth VellummyilumVinoth changed the title Document project instructions and skills features in copilot Document agents.md and skills features in copilot Jun 26, 2026
@github-actions

Copy link
Copy Markdown

Broken links, images & orphan pages

Passing — no broken links or images found.

Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by sidebars.ts.

Summary

  • Broken links & images — total 0 · 🆕 introduced 0 · 📄 already on main 0
  • Orphan pages — total 8 · 🆕 introduced 0 · 📄 already on main 8

Broken links & images

Introduced by this PR

No new broken link(s)/image(s) introduced by this PR. ✅

Already on main — 0 total

None.

Orphan pages

Introduced by this PR

No new orphan page(s) introduced by this PR. ✅

Already on main — 8 total

Already present on the base branch (not caused by this PR):

Show 8
  • docs/deploy-operate/observe/datadog-integration
  • docs/deploy-operate/observe/elastic-stack-elk
  • docs/deploy-operate/observe/metrics-prometheus-grafana
  • docs/deploy-operate/observe/opensearch-integration
  • docs/deploy-operate/observe/recipe-elk-stack
  • docs/deploy-operate/observe/recipe-kubernetes-production
  • docs/deploy-operate/observe/recipe-local-development
  • docs/deploy-operate/observe/recipe-opensearch-setup

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.

1 participant