Repository files navigation

This repo creates the GitHub pages custom domaindocs.sparkfun.com and landing page that lists out all SparkFun GitHub product repos that have github pages documentation.

The list of available pages is created automatically by a GitHub Action that runs nightly. This GitHub actions searches for repos under the spakfun organization that have the topicsparkfun-tutorial.

For a repo to be added to the list of documents, the following should be true in the About section of the repo:

• The repo has the topicsparkfun-tutorial
• Thewebsite section for the repo points to the GitHub Pages URL for that repo (check the provided option when editing the about page).
• The value of the description is provided

• Daily, or on a check in, the update action runs
• The Action using thggh command to search for all public sparkfun respositories that have the topicsparkfun-tutorial
• For each repositoriy found, the repo URL, About website and About description are retrieved
• The results of the query are writting to the filegsg.json as an array of json objects.
• The updatedgsg.json file is checkin to this repo and the landing page is rebuilt (automtically by GitHub)
• When the fileindex.html is loaded by a browser (for the landing page), it reads the filegsg.json and renders the documentation list table using javascript