TOC branch

TOC branch will contain

• index.html

• config.json

• robots.txt

• css/

• js/

• images/

Config.json

• It will be the controlling unit of the docs site. It will provide flags if some version is to be displayed on the main TOC page and on the Sidebar or not.

• Whenever a new version doc is added or removed, the config file will have to be updated. 

{
   "versions": [

                       {
                            "version": "2.0",
                            "desc": "",
                            "published": true,
                            "latest": true
                       },
                       {
                            "version": "1.9",
                            "desc": "",
                            "published": true,
                            "latest": false
                       },
                       {
                            "version": "1.8",
                            "desc": "",
                            "published": true,
                            "latest": false
                      }
                 ]
}

Widgets

Types 

1. TOC

2. Sidebar

3. Notification - latest version available on prior versions.

Widget working

1. Widgets will be based on handlebar template

2. Widgets will consume data from the manifest file from each version. 

3. manifest files will be included with require.js

Note

robots.txt 

• If any of the version is unpublished, then that directory will have to be disallowed to be indexed in Search engines.