breatheco-de / main-documentation

This repository servers like an aggregator everything that is being developed and publish in breathecode.
7 stars 18 forks source link

Github App that checks for broken links on .md .yaml .json files. #34

Open alesanchezr opened 5 years ago

alesanchezr commented 5 years ago

Github is becoming a create storage engine for educational content like Tutorials, Blog Posts, etc.

One of the biggest problems with mantaining content is broken links, when the blogpost author writes the article he includes a link to a 3rd party resource, after some times has passed those links could be down because no one maintained them.

It would be ideal to have a github app that checks for broken links on the entire repository and creates issues to fix them. Similar to this one but for xml, json and markdown as well: https://probot.github.io/apps/yamburger/

To develop it you have to use the probot framework based in node.js