Skip to content

[Search] Add samples authoring reference to azure-search-documents skill#47689

Open
hizixin wants to merge 1 commit into
mainfrom
search/samples-authoring-skill
Open

[Search] Add samples authoring reference to azure-search-documents skill#47689
hizixin wants to merge 1 commit into
mainfrom
search/samples-authoring-skill

Conversation

@hizixin

@hizixin hizixin commented Jun 26, 2026

Copy link
Copy Markdown
Member

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Add references/samples.md (live-run setup plus the Adding new samples checklist) and register it as a sidecar in SKILL.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 26, 2026 17:43
@hizixin hizixin requested review from a team as code owners June 26, 2026 17:43

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.

Pull request overview

This PR extends the package-specific GitHub skill for azure-search-documents by adding a new references/samples.md sidecar that documents the live-run setup and the mandatory checklist for authoring/updating samples, and links to it from the skill's "Additional references" list. It mirrors the existing sidecar pattern already used by references/release.md and references/testing.md, and its guidance aligns with the conventions of the package's newer preview samples (DESCRIPTION/USAGE docstrings, run_tag-based resource names, # [START]/# [END] tags, sample_utils.py helpers, and sync/async pairing).

Changes:

  • Added a new references/samples.md sidecar describing live-sample environment setup and a 6-item sample authoring checklist.
  • Linked the new sidecar from SKILL.md's "Additional references" section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
sdk/search/azure-search-documents/.github/skills/azure-search-documents/SKILL.md Adds a bullet referencing the new references/samples.md sidecar.
sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/samples.md New sidecar documenting live-run setup and the sample authoring checklist.

The content is internally consistent and matches existing sample patterns. The one observation is a nit: unlike the testing sidecar, the new samples sidecar tells users to "create" the live-env script without providing an analogous committed Set-LiveSampleEnvironment.sample.ps1 template to copy from.

@@ -0,0 +1,20 @@
# azure-search-documents samples

Samples run live against a search service. Create `Set-LiveSampleEnvironment.ps1` from the release resources to set the env vars the samples read, keeping secrets out of it. Run commands from `sdk/search/azure-search-documents/` using the `venv` alias from `SKILL.md`:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

4 participants