Add audit-sdk-docs skill and fix outdated doc references#48114
Draft
msyyc wants to merge 3 commits into
Draft
Conversation
Adds an agent-maintained skill (.github/skills/audit-sdk-docs) that scans repo Markdown/rST docs for outdated references (broken relative links, dead in-repo GitHub URLs, missing inline path refs), excluding the auto-generated sdk/ tree and centrally-synced eng/common. Also fixes two stale references found by the scanner: - doc/dev/conda-builds.md: eng/conda_env.yml -> conda/conda-recipes/conda_env.yml - doc/dev/mgmt/tests.md: sample conftest.py link repointed to an existing package Relates to Azure#48112 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3971b453-9687-459a-b084-b4b4697f6caa
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
…, self-improve Adds three audit dimensions beyond stale references: - annotation vs code drift (docstrings/comments match real code) - duplicated or contradictory docs about the same concept - doc simplification Also makes the skill self-improving: the mandatory last step reviews the process and folds any reusable pattern/solution back into the skill, committed in the same PR. Relates to Azure#48112 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3971b453-9687-459a-b084-b4b4697f6caa
Dimension 3/4: doc/dev/conda-builds.md CI Build Process bullets duplicated and partly contradicted the authoritative, now-automated process in conda-release.md. Consolidated to a single-source-of-truth pointer; this page stays focused on local builds. Self-improve (skill Step 6): record the reusable finding that a MISSING_PATH_REF introduced with "Previously in"/"formerly"/"moved from" is intentional history and must be left alone, plus this run's example findings. Relates to Azure#48112 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3971b453-9687-459a-b084-b4b4697f6caa
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
1 participant
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.
Summary
An agent-maintained, self-improving skill to keep repo docs and code annotations accurate, current, and non-redundant, so agents get the right info from the repo. Relates to #48112. Includes two doc fixes the skill surfaced.
New skill: .github/skills/audit-sdk-docs
Audits across four dimensions (each run as a small, judged batch):
scripts/check_outdated_docs.py(excludessdk/,eng/common*,node_modules).Self-improving: the mandatory last step reviews the process and folds any reusable pattern/solution back into the skill, committed in the same PR.
Doc fixes found by the skill (Dimension 1)
doc/dev/conda-builds.md:eng/conda_env.yml->conda/conda-recipes/conda_env.yml(moved in Refactor Conda Pipeline #31804; verified viaconda_functions.pyget_version_from_config).doc/dev/mgmt/tests.md: sampleconftest.pylink repointed from the removedsdk/advisor/azure-mgmt-advisor/tests/tosdk/apimanagement/azure-mgmt-apimanagement/tests/conftest.py.Follow-ups (left for a separate batch)
eng/tools/azure-sdk-tools/README.mdreferences missingscripts/devops_tasks/build_packages.py(likely moved).Draft PR for review of the approach.