Repository navigation
Deep-link the Agent 365 checklist into the guide and keep them in sync - #569
Merged
Alejandro Lopez (soyalejolopez) merged 1 commit intoOct 29, 2026
Conversation
…y stay in sync The guide now opens #advanced/<step> (a step code or section number) in its Detailed view, applied as a repeatable patch from tools/catalog-build/guide-deeplinks.js. Each checklist task links to its exact guide step, and six Defender references now name their step code. npm run check now fails when a checklist reference or link no longer matches the guide, when the guide loses the deep-link script, or when a cited guide step changes without the dependent checklist tasks being reviewed (fingerprints recorded by npm run sync:agent365). The guide's review date moves into the sync state, and the weekly workflow adds a real-browser test of every deep link. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Alejandro Lopez (soyalejolopez)
merged commit Oct 29, 2026
e54c4dd
into
microsoft:master
5 checks passed
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
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.
Category
What's in this pull request?
Adds deep links from the Agent 365 Enablement Checklist into the Customer Implementation Guide, and makes
npm run checkenforce that the two stay in sync.Deep links
index.html#advanced/<key>in its Detailed view, scrolls to the step, highlights it, and moves focus to it.<key>is a step code in lowercase (4.04a,12b,pp3,5-0) or a section number (04,pp).#simple,#advanced, and the Simple and Detailed buttons behave as before. No guide content changes.tools/catalog-build/guide-deeplinks.js, 73 added lines in the generated guide) rather than a hand edit, so it can be reapplied if the guide is regenerated.guideHref()function. Six Defender tasks named their guide step only in words, so they now name its code. One of them, "Review real-time protection rules", had been matching step 2.02; it now points at 2.06 (Set up real-time protection rules).Keeping the two aligned (
npm run check, so it runs on every PR)guideHref()must build the address the check expects for every reference, and the guide must offer that address.tools/catalog-build/agent365-sync-state.json(its text and links). Editing a cited step fails the check and names the checklist tasks that depend on it. After reviewing them, runnpm run sync:agent365and commit the state file. The pull request template has a matching checkbox.updateddate for a non-content change no longer counts as a review.npm run sync:agent365 -- --guide-reviewedrecords one.Weekly workflow: a second job opens every address the checklist links to in a real headless browser and checks that the guide finds each step (
npm run test:guide-deeplinks).Versions: guide 1.3.0 to 1.4.0, checklist 1.0.1 to 1.0.2. The checklist's
CONTENT_VERSIONandCONTENT_REVIEWEDare unchanged because its content was not reviewed.How it was tested
npm run checkpasses: 78 references link to existing steps and sections, the deep-link script is current, and 74 cited steps match their fingerprints.found, and an unknown key reportedmissing.#advanced/2.01,2.06,2.02, and2.07.Related issues
Follows #567. Part of the revamp tracked in #482.
Checklist
npm ci --prefix tools/catalog-build && npm run check --prefix tools/catalog-build(passes)versionandupdatedwere bumped (andpublishedwas preserved) (guide 1.4.0, checklist 1.0.2)npm run sync:agent365 --prefix tools/catalog-build(the recorded fingerprints are the baseline; no cited step changed)See CONTRIBUTING.md for details.