intel / rohd

The Rapid Open Hardware Development (ROHD) framework is a framework for describing and verifying hardware in the Dart programming language.
https://intel.github.io/rohd-website
BSD 3-Clause "New" or "Revised" License
374 stars 67 forks source link

[WIP] Add local Markdown checks #330

Open chykon opened 1 year ago

chykon commented 1 year ago

Description & Motivation

This set of changes adds an easy way to locally check text formatting and link health in Markdown files.

TODO: Add required dependencies to GitHub Codespaces (check https://containers.dev/features).

Related Issue(s)

No.

Testing

Run checks locally and see the output.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

No.