Temporarily disable broken markdownlint-cli hook

[alexdewar]

Description

The markdownlint-cli hook is currently broken due to an upstream bug. Let's just disable it for now as it's causing CI failures. We can re-enable it later and re-run it over any markdown files we've changed.

Type of change

• Bug fix (non-breaking change to fix an issue)
• New feature (non-breaking change to add functionality)
• Refactoring (non-breaking, non-functional change to improve maintainability)
• Optimization (non-breaking change to speed up the code)
• Breaking change (whatever its nature)
• Documentation (improve or add documentation)

Key checklist

• All tests pass: $ cargo test
• The documentation builds and looks OK: $ cargo doc
• Update release notes for the latest release if this PR adds a new feature or fixes a bug
  present in the previous release

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.30%. Comparing base (3dc09d7) to head (f295613).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1179   +/-   ##
=======================================
  Coverage   87.30%   87.30%           
=======================================
  Files          57       57           
  Lines        7706     7706           
  Branches     7706     7706           
=======================================
  Hits         6728     6728           
  Misses        673      673           
  Partials      305      305           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

Temporarily disables the markdownlint-cli pre-commit hook to avoid CI failures caused by an upstream markdownlint-cli issue.

Changes:

• Comments out the markdownlint-cli repo + markdownlint-fix hook block in .pre-commit-config.yaml
• Adds a note with a link to the upstream issue causing fresh-install breakage

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Commenting out the entire hook works, but it also removes the ability to run it intentionally (e.g., in a manual stage) and makes future re-enabling slightly more error-prone. Consider keeping the hook enabled but restricting it to stages: [manual] (or an equivalent non-default stage used in this repo) so contributors can still run it explicitly while CI/normal pre-commit stages remain unblocked.

Suggested change

	# - repo: https://github.com/igorshubovych/markdownlint-cli
	# rev: v0.48.0
	# hooks:
	# - id: markdownlint-fix
	- repo: https://github.com/igorshubovych/markdownlint-cli
	rev: v0.48.0
	hooks:
	- id: markdownlint-fix
	stages: [manual]

[tsmbland]

Sure.

Is this an issue with all versions or just the latest version? (i.e. could we downgrade instead?)

[alexdewar]

I tried downgrading and it didn't work 😞. I think the issue is a transitive dep of markdownlint-cli being broken and I guess they haven't pinned the version.