search

instructlab / ui

Place to hack on UI for InstructLab
Apache License 2.0
15 stars 36 forks source link

Add dev instructions of how to run the Markdown linter locally #46

Closed aevo98765 closed 4 months ago

aevo98765 commented 4 months ago

I made changes to a MD file and found that the CI pipeline failed because of the Markdown linter. I didn't know how to run this locally on my machine which would make it easier to correct these linting issues.

Acceptance Criteria:

Add instructions of what tool and how to install the Markdown linter locally for devs to run checks before pushing remotely.

vishnoianil commented 4 months ago

@aevo98765 in the makefile, there is a target md-lint that runs the linter locally. That didn't work for you?

aevo98765 commented 4 months ago

Hey @vishnoianil, ahh I haven't been using the Makefile in this project. Do we think it is worth having instructions of how to run the MD linter outside of the Makefile or just comment to use the Makefile if you want to run the linting checks... or... just close this issue off as not needed?

vishnoianil commented 4 months ago

@aevo98765 in my opinion, let's stick with makefile as of now, we can always change if that's not working for folks. Having documented it somewhere that dev can use md-lint target to lint the markdown files would be awesome.

aevo98765 commented 4 months ago

https://github.com/instructlab/ui/pull/75 @vishnoianil