Home

NOTE: Any manual changes to Github Wiki will be overwritten by push (PR merged) to master branch

These files should updated whenever we merge to master, and be in sync between:

• The README files in the repo,
• The Github Wiki, and
• The generated doc site served when running the server and on github pages

This project uses a Github Action to accomplish this. The action is executed on merge to the master branch and defined inside of the ./.github/workflows/ directory(github) (along with all other github actions) that creates a commit to update the docs directory on github and then calls a script in the scripts/actions directory(github).

The script retrieves the following markdown files (defined in ./.esdoc.json) and copies them to a temporary directory, then uses the wiki-page-creator-action to update the Github wiki.

Table of Contents

• Setup - dependencies and how to install and start development (eventually production?)
• Entry - How Javascript Bundles are defined and files that can be included
• HTML - How HTML files are created and the processes we use to ensure quality
• CSS - CSS Normalization, Processing and Frameworks
• Images - Including images and SVG icons from free library
• Helpers - Javascript Helper Classes and Code that is used in the project
• Static HTML Components - HTML Components that are generated during the build process
• Dynamic HTML Components - HTML/JS Components that are created with Handlebars dynamically during runtimes
• Github Actions - Notes about Actions run on to ensure quality
• Testing - How testing is configured and how to run tests
• Custom Webpack Loaders - Explaining how we configure webpack loaders to generate the application

.