Skip to content

Commit

Permalink
reward link checker flow per feedback #259
Browse files Browse the repository at this point in the history
Co-authored-by: Marc Abbyad <[email protected]>
  • Loading branch information
mrjones-plip and abbyad authored Aug 10, 2020
1 parent f9ed26f commit f6a5df5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To install, follow the [installation instructions for your Operating System](htt

## Link Checking [Optional]

We validate that all links on the docs site work (do not 404) using a tool called [Muffet](https://github.com/raviqqe/muffet) along with [Actions](https://github.com/features/actions). If you're creating a lot of new links, or editing a lot of existing links, you may optionally run Muffet locally before pushing your commits. This will save a lot of time of pushing a build, waiting for the Action to run, finding you have a broken link, fixing it, pushing a new change etc.
We validate that all links on the docs site work (do not 404) using a tool called [Muffet](https://github.com/raviqqe/muffet) along with [Actions](https://github.com/features/actions). If you're creating a lot of new links, or editing a lot of existing links, you may optionally run Muffet locally before pushing your commits. Running Muffet locally can save time by exposing broken links before pushing a build since you can avoid waiting for the Action to run, finding you have a broken link, fixing it, and pushing a new change.

- Install [Go](https://golang.org/doc/install) as a prerequisite
- Install Muffet: `go get -u github.com/raviqqe/muffet`
Expand Down

0 comments on commit f6a5df5

Please sign in to comment.