[Search] Add samples authoring reference to azure-search-documents skill#47689
[Search] Add samples authoring reference to azure-search-documents skill#47689hizixin wants to merge 1 commit into
Conversation
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>
There was a problem hiding this comment.
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.mdsidecar 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`: | |||
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:
General Guidelines and Best Practices
Testing Guidelines