Skip to content

chore(scenarios): deep-link KB Resolution Steps and Lab Verification sections#2

Closed
iplaycomputer wants to merge 10 commits intomainfrom
chore/deep-links-scenarios
Closed

chore(scenarios): deep-link KB Resolution Steps and Lab Verification sections#2
iplaycomputer wants to merge 10 commits intomainfrom
chore/deep-links-scenarios

Conversation

@iplaycomputer
Copy link
Copy Markdown
Owner

Deep-Link Refinement & PR Template Update

Description

This update implements precise deep-linking across all four scenario files, ensuring they point directly to the appropriate anchors in related modules. It also updates the Pull Request (PR) template to codify the new anti-duplication and deep-linking requirements for continuous hygiene.

Summary

Adds precise deep-links in all 4 scenario files so they point directly to KB “Resolution Steps” and Lab “Verification.” Updates PR template with anti-duplication & deep-link checks and review guidance.

Changes

File Change Details
scenarios/account-lockout-reset.md → KB #resolution-steps, Lab #verification link updates
scenarios/printer-queue-clearing.md → KB #resolution-steps, Lab #verification link updates
scenarios/outlook-reconnect-after-update.md → KB #resolution-steps, Lab #verification link updates
scenarios/workstation-performance-triage.md → KB #resolution-steps, Lab #verification link updates
PULL_REQUEST_TEMPLATE.md → Add anti-duplication + deep-link checks; lab/KB/scenario sub-checks; reviewer verify steps

Rationale

This change aligns with the project's CONTRIBUTING and AI guidance:

  • Commands live exclusively in Labs.
  • KBs have productized steps + brief verification.
  • Scenarios define flow/success and must link precisely to these anchor sections.

This reduces duplication and significantly improves navigation and maintainability of the entire simulator.

Verification

To verify this change:

  1. In each scenario file, click the Related KB/Lab links; they should jump directly to the correct anchors (#resolution-steps or #verification).
  2. If any Lab was changed, run the Verification steps within the Lab environment and confirm expected outputs.
  3. Confirm no personal IPs/credentials were added; use <vm-ip> placeholders.

Risk

The changes are limited to documentation files (.md) and have no runtime impact on the lab environment or Docker assets.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements precise deep-linking across scenario files to improve navigation and reduce duplication by ensuring scenarios point directly to specific sections in related KB and Lab files. The changes also introduce markdown linting infrastructure and update the PR template with anti-duplication guidelines.

Key changes:

  • Updated all four scenario files to use deep links pointing to KB #resolution-steps and Lab #verification sections
  • Added markdownlint configuration and GitHub Actions workflow for automated markdown quality checks
  • Enhanced PR template with specific checklist items for anti-duplication and deep-linking requirements

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
scenarios/*.md (4 files) Updated Related KB/Lab links to use deep anchors (#resolution-steps, #verification)
.markdownlint.jsonc Added markdown linting configuration with relaxed rules for common patterns
.markdownlint-cli2.jsonc Added CLI configuration for markdownlint with file globs and ignore patterns
.github/workflows/markdownlint.yml Added GitHub Actions workflow for automated markdown linting
.github/copilot-instructions.md Minor formatting improvements with additional blank lines
.github/PULL_REQUEST_TEMPLATE.md Enhanced template with anti-duplication checks and reviewer verification steps
.github/CODEOWNERS Added code ownership configuration requiring maintainer review

…int config

- Left-align Verification headings in labs
- Ensure blank lines around fenced blocks and add languages
- Keep only MD013/MD025/MD033 disabled in .markdownlint.jsonc
@iplaycomputer iplaycomputer marked this pull request as draft September 28, 2025 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants