This feature adds broken links checking into the serve and build processes. It actually already uncovered a couple broken links we had in our own docs!
If there are broken internal links, the build process will return an error. Users can opt out of these errors by using the --allow-failed-checks flag. This keeps the option open to adding futher checks in the future if we want.
This change also includes a decent refactoring of how Doctave actually generates sites. Now each command interacts with a Site struct that is generic over a backend implementation (disk or in-memory). The Site is responsible of loading docs from disk, and then passing them to the backend once the HTML has been generated.
Closes #13
This feature adds broken links checking into the
serveandbuildprocesses. It actually already uncovered a couple broken links we had in our own docs!If there are broken internal links, the
buildprocess will return an error. Users can opt out of these errors by using the--allow-failed-checksflag. This keeps the option open to adding futher checks in the future if we want.This change also includes a decent refactoring of how Doctave actually generates sites. Now each command interacts with a
Sitestruct that is generic over a backend implementation (disk or in-memory). TheSiteis responsible of loading docs from disk, and then passing them to the backend once the HTML has been generated.