search

nasa / fprime

F´ - A flight software and embedded systems framework
https://fprime.jpl.nasa.gov
Apache License 2.0
9.96k stars 1.29k forks source link

feat(ci): add markdown link checker #2651

Closed SauravMaheshkar closed 2 months ago

SauravMaheshkar commented 3 months ago
Related Issue(s) #1840
Has Unit Tests (y/n) n
Documentation Included (y/n) n

Change Description

This PR adds a workflow for checking broken links in Markdown files

Rationale

Fixes #1840

LeStarch commented 3 months ago

Well, without surprise....this yielded many changes necessary.

thomas-bc commented 3 months ago

I think we may want to use 

  - use-quiet-mode: 'yes'

Specify yes to only show errors in output.

https://github.com/gaurav-nelson/github-action-markdown-link-check?tab=readme-ov-file#custom-variables

SauravMaheshkar commented 3 months ago

How would you like to proceed with this:

A) incorporate all links fixes in this PR. (maybe even one squash'ed commit) B) Merge this PR, and make subsequent PRs fixing the links.

Something else?

thomas-bc commented 3 months ago

I think we're going to want to go with A otherwise it's going to break other PRs and the main branch. We squash PRs as a single commit so no worries about making lots of small commits. I'll give you a hand as soon as I can

thomas-bc commented 3 months ago

Well, that was cumbersome, but that should do it!

A very few things was so old that I removed it. Most were tracked down. A couple in the CMake API I hardcoded, since the relative ../api/ links are dead in Markdown anyways, since api/ is generated a docgen-time

We might take a little while to review everything. Will get back to you once we got back to it.

SauravMaheshkar commented 3 months ago

Well, that was cumbersome, but that should do it!

A very few things was so old that I removed it. Most were tracked down. A couple in the CMake API I hardcoded, since the relative ../api/ links are dead in Markdown anyways, since api/ is generated a docgen-time

We might take a little while to review everything. Will get back to you once we got back to it.

Thanks for all the help @thomas-bc

thomas-bc commented 2 months ago

@SauravMaheshkar would you be able to make the changes that were requested by LeStarch's review, as well as resolving the merge conflict? All changes from devel in docs/UsersGuide/dev/testAPI/user_guide.md should be taken in