Skip to content

docs(skills): split operational references into sub-list - #2904

Open
pratik wayase (PratikWayase) wants to merge 2 commits into
microsoft:mainfrom
PratikWayase:docs/skills-split-operational-references-2449
Open

pratik wayase (PratikWayase) wants to merge 2 commits into
microsoft:mainfrom
PratikWayase:docs/skills-split-operational-references-2449

Conversation

@PratikWayase

Copy link
Copy Markdown
Contributor

Description

This PR resolves issue #2449 by splitting the operational reference documents into a dedicated "Operational references" sub-list within the privacy-standards SKILL.md framework index.

Previously, data-governance-controls.md and dpia-thresholds.md were mixed in with the main framework standards (NIST, GDPR, etc.). Grouping them into a nested sub-list improves readability and separates planning synthesis docs from official standards packages.

Related Issue(s)

Closes #2449 Closes #2450

Note: #2450 is a duplicate of #2449, so both are being closed by this PR.

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with hve-builder and addressed all actionable findings
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)
  • Copilot hook (.github/hooks/*/*.json)
  • Eval spec added/updated for changed AI artifacts (evals/)

Sample Prompts (for AI Artifact Contributions)

N/A - This is a structural documentation update to an existing skill's reference index, not a new AI artifact contribution.

Testing

  • Verified the Markdown syntax uses correct 2-space indentation for the nested sub-list to pass markdown linting.
  • Confirmed that both data-governance-controls.md and dpia-thresholds.md are correctly linked and moved under the "Operational references:" bullet.
  • Verified the Framework index standards (NIST, GDPR, CCPA, OWASP) remain untouched.

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

  • Used hve-builder review mode to review contribution
  • Addressed all actionable findings from the hve-builder review
  • Verified contribution follows common standards and type-specific requirements

Required Local Checks

The following local-safe validation commands must pass before merging:

  • Local validation aggregate: npm run validate:local
  • Documentation validation (if docs changed): npm run validate:docs
  • Spell checking: npm run spell-check
  • Link validation: npm run lint:md-links

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

Additional Notes

This change was originally deferred from PR #2416 to avoid scope creep. The trigger condition for this split (adding a second operational reference doc) has now been met with the addition of data-governance-controls.md.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.97%. Comparing base (9569d84) to head (bdc563c).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2904      +/-   ##
==========================================
- Coverage   83.00%   82.97%   -0.04%     
==========================================
  Files         185      173      -12     
  Lines       34924    34775     -149     
  Branches      228      201      -27     
==========================================
- Hits        28989    28854     -135     
+ Misses       5861     5850      -11     
+ Partials       74       71       -3     
Flag Coverage Δ
docusaurus ?
pester 83.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 14 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Labels

None yet

Projects

None yet

3 participants