Codecademy / docs

Codecademy Docs is a collection of information for all things code. 📕
https://www.codecademy.com/resources/docs
810 stars 3.61k forks source link

Github check to verify that there are not missing md files #5553

Open jrood opened 3 weeks ago

jrood commented 3 weeks ago

This is meant to prevent "orphaned" docs such as a terms where the parent concept does not have an md file.

Rather than checking for that specifically, we can more generally check to make sure that every folder for a topic/concept/term contains an md file with the same name.

Even after this is merged, it won't be required-for-merge until we add it as a required check in the repo's settings: (Settings -> Branches -> main -> Edit -> Status checks that are required)

Sriparno08 commented 1 day ago

Hey @jrood, just wanted to have a little update from your side on the progress of this PR.

Plus, I think we should wait for it to get ready and then assign it to ourselves, right?