[Tentative]

blocks #729

Overview

The current loopback.io scripts for our documentation will pull in READMEs without issue, but they are limited in their ability to parse other Markdown documents at top-level or in subdirectories.

As a result, we are unable to pull in documentation from things like the example-getting-started repository in a way that mimics the current setup in GitHub for our own documentation

Examples of problems include:

• Links becoming broken after import and conversion to HTML (docs paths don't correspond to resulting Liquid templating paths)
• Every single document that needs to be parsed must be added to the scripts (this could quickly grow out of control with respect to tracking and management of sourced documentation)

To correct this, we should change the scripts so that we can:

• source a common target by convention from an existing repository (ex. docs folder)
• generate the include files (for reference, this is an include file)
• organize our include files in directories that mirror their source package structure to make maintenance and manual navigation easier

Acceptance Criteria

-- todo --

cc @raymondfeng @bajtos @dhmlau