Skip to content

chore: strict markdownlint, deep-link fixes, and editor guardrails#3

Merged
iplaycomputer merged 28 commits intomainfrom
chore/deep-links-scenarios
Sep 29, 2025
Merged

chore: strict markdownlint, deep-link fixes, and editor guardrails#3
iplaycomputer merged 28 commits intomainfrom
chore/deep-links-scenarios

Conversation

@iplaycomputer
Copy link
Copy Markdown
Owner

@iplaycomputer iplaycomputer commented Sep 28, 2025

chore: strict markdownlint, deep-link fixes, and editor guardrails

Summary

Enforce a strict markdownlint baseline, standardize deep-link anchors across Scenarios → KB/Lab, and align editor behavior to minimize visual churn. Formatting-only; no procedure changes.

Linked Artifacts (relative paths)

  • Ticket(s)
    • account-locked-out.md
    • cannot-print-to-shared-printer.md
    • computer-running-slow-lagging.md
    • outlook-disconnected-password-prompts.md
  • KB
    • account-lockout-reset.md
    • printer-queue-clearing.md
    • workstation-performance-triage.md
    • outlook-reconnect-after-update.md
  • Lab
    • print-queue-stuck.md
    • resource-spike-triage.md
    • mailhog-connectivity.md
  • Scenario
    • account-lockout-reset.md
    • printer-queue-clearing.md
    • workstation-performance-triage.md
    • outlook-reconnect-after-update.md

Also touched (templates/docs)

  • .markdownlint.jsonc
  • .markdownlint-cli2.jsonc
  • .markdownlintignore
  • CONTRIBUTING.md
  • 000.scenario-template.md
  • 000.lab-template.md
  • 000.ticket-template.md
  • README.md
  • README.md

Checklists

  • Content

    • Uses the correct template (copied from 000.*-template.md)
    • Clear, reproducible steps and plain language
    • Relative links resolve inside the repo
    • Avoid duplication across modules (KB = productized steps; Lab = full commands + Verification; Scenario = flow/success, links only)
    • Deep link to sections where applicable (KB → #resolution-steps, Lab → #verification)
  • Metadata

    • Owner set; Last Reviewed and Next Review Due (KB/Lab)
    • Escalation Path filled (Ticket)
    • Metrics block added if useful (see docs/METRICS.md)
  • Quality

    • Verification steps included (expected outputs / pass-fail)
    • Anchors exist and resolve (KB “Resolution Steps”, Lab “Verification”)
    • Scenario (if present) ties Ticket → KB → Lab and defines success criteria

Labs (if included)

  • Dedicated “Verification” section with expected outputs
  • Images pinned if using containers; HTTP services include a simple healthcheck when applicable
  • Assets stored under labs/<lab>/assets/

KBs (if included)

  • Brief (1–2 lines) verification; link to related Lab for full commands

Scenarios (if included)

  • Uses deep links to KB “Resolution Steps” and Lab “Verification” (no step duplication)

Notes

Changes

  • Set strict markdownlint baseline; disabled only:
    • MD013 (line length), MD025 (multiple top-level headings), MD033 (inline HTML),
    • MD009 (trailing spaces), MD041 (first line heading), MD051 (link fragments)
    • MD029 style set to “ordered” to reduce renumbering churn
  • Added repo-level config/parity:
    • .markdownlint-cli2.jsonc with glob/ignore config (ignores .github/**/*.md and README.md)
    • .markdownlint.jsonc rules as above; .markdownlintignore to match editor behavior
  • Structural fixes across docs:
    • Normalized spacing around headings/lists/fences (MD022/MD031/MD032)
    • Converted bold-only pseudo-headings to real headings where present (MD036)
    • Replaced bare URLs with angle-bracketed links (MD034) where needed
  • Deep-link alignment:
    • Scenarios link to KB “Resolution Steps” and Lab “Verification” anchors
    • Removed duplicated steps across modules
  • Contributor experience:
    • CONTRIBUTING.md: added “Local Lint (Optional)” and a pre-commit hook tip
    • README excluded from lint to avoid emoji/formatting churn

Rationale

  • Anchor stability and consistent formatting reduce merge noise and broken links.
  • Editor parity and scoped ignores prevent unnecessary diffs and preserve readability.

How to Verify (for reviewers)

  • Local: run markdownlint (or use the provided local command in CONTRIBUTING). Expect 0 errors.
  • Manual: open each Scenario and click the KB/Lab deep links; confirm anchors jump to “Resolution Steps” and “Verification.”
  • Confirm no procedural content changes—only formatting/structure.

@iplaycomputer iplaycomputer self-assigned this Sep 28, 2025
@iplaycomputer iplaycomputer added bug Something isn't working invalid This doesn't seem right labels Sep 28, 2025
- Disable MD041 and MD051 to match pipeline plan
- Add VS Code extension recommendations
- Enable markdownlint fix-on-save for Markdown
@iplaycomputer iplaycomputer removed the bug Something isn't working label Sep 28, 2025
- Ticket template: fix malformed heading and add required blank lines
- Printer ticket: remove stray text and add blank line before checklist
- Disable MD009 (allow soft-break trailing spaces)
- Fix heading/list spacing in scenarios to satisfy MD022/MD032
- Add blank lines around headings, lists, and code fences (MD022/MD032/MD031)
- Add code fence language in README and normalize list indentation (MD040/MD007/MD005)
- Remove stray backticks and extra blank lines in scenarios and tickets (MD012)
- No content changes
- Respect user’s whitespace adjustments while keeping required blank lines
- Normalize any reintroduced list/fence spacing per rules
- No content changes
…-stuck

- Add blank lines around headings/lists/fences (MD022/MD032/MD031)
- Convert bare URL to angle-bracket link (MD034)
- Normalize bullet/fence indentation
- No content changes
- Add blank lines around headings and lists
- No content changes
…emplates and meta docs; keep strict rules elsewhere
…and wrap bare URLs across KBs and labs (MD022/MD032/MD031/MD034); fix list indent issues (MD005/MD007)
…t indent; allow ordered lists (MD029) via config

- Convert bold-only pseudo-headings to proper headings where applicable (MD036)
- Ensure blank lines around code fences (MD031), lists (MD032), and headings (MD022)
- Normalize top-level list indentation (MD007)
@iplaycomputer iplaycomputer merged commit b58a5fe into main Sep 29, 2025
1 check passed
@iplaycomputer iplaycomputer deleted the chore/deep-links-scenarios branch September 29, 2025 15:55
@iplaycomputer iplaycomputer removed the invalid This doesn't seem right label Sep 29, 2025
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.

1 participant