Skip to content

docs(compliance): add stable per-control anchors for external deep links - #3895

Open
Dipak Chaudhari (dchaudhari7177) wants to merge 1 commit into
microsoft:mainfrom
dchaudhari7177:docs/3811-stable-control-anchors
Open

docs(compliance): add stable per-control anchors for external deep links#3895
Dipak Chaudhari (dchaudhari7177) wants to merge 1 commit into
microsoft:mainfrom
dchaudhari7177:docs/3811-stable-control-anchors

Conversation

@dchaudhari7177

Copy link
Copy Markdown

Refs #3811.

Adds stable per-control anchors to the two docs that carry the control taxonomy, so OpenCRE (and any other external standard) can deep link to a control and keep resolving.

Anchor scheme

docs/compliance/atf-conformance-assessment.md — 25 anchors, one per requirement, <control-id>-<name-slug>:

<a id="i-3-ownership-chain"></a>

#### I-3: Ownership Chain — ✅ FULLY MET

That is the exact form the issue asked for. It matters that these are explicit rather than generated: the headings carry their conformance status inline, so the generated anchor for I-3 is #i-3-ownership-chain--fully-met today and becomes #i-3-ownership-chain--partially-met the moment the status changes. That is precisely the rot the issue calls out as worse than no anchor.

docs/compliance/owasp-asi-policy-mapping.md — 68 anchors, one per policy rule. The rules live in table rows, not headings, so there is nothing to generate an anchor from at all. Each anchor is keyed on the rule name itself (#asi01-prompt-injection-override) rather than a slug of surrounding prose, because the rule name is the durable identifier — it is what the policy packs are keyed on, so it cannot be reworded without a rule rename.

Why <a id> rather than {#id}

attr_list is enabled in mkdocs.yml, so {#i-3-ownership-chain} would work on the docs site. I used the HTML-anchor form because these compliance docs are also read directly on GitHub, which does not support attr_list and would render the braces as literal text. It is also the form already established in docs/compliance/nist-ai-rmf-alignment.md.

Verified

  • 25 + 68 = 93 anchors, all unique within their file, all matching [a-z0-9][a-z0-9-]*.
  • Rendered both files through python-markdown with the site's attr_list, md_in_html, tables and toc extensions: 93 anchors present in the output, #i-3-ownership-chain and #asi01-prompt-injection-override both resolve, and the tables still render (93 and 128 rows) — the inline anchor in the first cell does not break the row.
  • No prose, status, or mapping content changed; the diff is anchors only.

Out of scope per the issue: the mapping content itself.

The ATF headings carry their conformance status in the heading text
("#### I-3: Ownership Chain — ✅ FULLY MET"), so a generated anchor moves
whenever a control's status changes, and the policy rules live in table
rows with no anchor at all. Neither can be linked to durably from outside.

Add explicit `<a id="...">` anchors: control id plus name slug for the 25
ATF requirements, and the rule name itself for the 68 policy rules, since
that name is already the durable identifier. Both are independent of the
surrounding prose, so rewording a heading or changing a status no longer
moves the target.

Uses the HTML-anchor form already established in
docs/compliance/nist-ai-rmf-alignment.md rather than attr_list `{#id}`:
these docs are read on GitHub as well as the MkDocs site, and GitHub does
not support attr_list.

Refs microsoft#3811.
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/M Medium PR (< 200 lines) labels Sep 7, 2026
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown

PR Review Summary

Check Status Details
🔍 Code Review ⚠️ Missing No current-run comment
🛡️ Security Scan ⚠️ Missing No current-run comment
🔄 Breaking Changes ⚠️ Missing No current-run comment
📝 Docs Sync ⚠️ Missing No current-run comment
🧪 Test Coverage ⚠️ Missing No current-run comment

Verdict: ⚠️ AI review incomplete; ready for human review

AI review comments are untrusted advisory output. The summary reports workflow-generated completion status only, not model-authored pass/fail claims.

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown

🟡 Contributor Check: MEDIUM

Check Result
Profile MEDIUM
Credential LOW
Overall MEDIUM

Automated check by AGT Contributor Check.

@github-actions github-actions Bot added the needs-review:MEDIUM Contributor check flagged MEDIUM risk label Sep 7, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

Dipak Chaudhari (@dchaudhari7177) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation needs-review:MEDIUM Contributor check flagged MEDIUM risk size/M Medium PR (< 200 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant