S R T B H P N
https://github.com/JimFawcett

SiteStory Introduction


Purpose of the Site:

This site is intended to provide access to, and documentation for, a collection of code resources. Much of the code was developed for my Syracuse University classes. New code will appear here for other things of interest now. Another intent is to experiment with ways to document and deploy code: how to provide quick access to important code fragments without impeding delivery of the entire product, how to balance browser view space between non-trivial text descriptions, diagrams, and images, and how to provide intuitive navigation through large collections of code and resources. This site currently has more than forty repositories, with many more coming. That is almost industrial scale, and so, we believe that what we do here is applicable for commercial and industrial development of software as well.

Story Contents:

The plotline for this story focuses on the things we are doing to achive those goals, in particular, experiments to test ideas for structuring code to make it easy to deploy into user applications and to test ways of explaining code so concept, design, and operations of the code are clear; and do so with a reasonable amount of effort. A fundamental assumption we make is that deploying code from the cloud - we are using github - and documenting it with pages from a static website, hosted from the same location, is an effective start. We take that as given, and proceed from there. So let's start with where we are now.

Site Structure:

The gateway into site contents is the Home page, shown in Figure 1. Its top menu provides access either directly or indirectly to all the site contents. The most important destination is the Repositories page, shown in Figure 2. That leads to each of the repositories via tables that provide summary information or, more directly, through its top menu providing direct access to each of the repositories. Various parts are shown in Figure 3. The main characters in this SiteStory are the Repositories and Stories.

Repositories:

Repositories are where we store all the code to be deployed. Each repository has a documentation page and code. For example the CppUtilities repository documentation page is CppUtilities.html and the code resides in https://github.com/JimFawcett/CppUtilities.html.

Stories:

The other principal feature we will discuss is the provision of stories. A Story is a sequence of resources - mostly pages - drawn from this site that have a common theme. The theme of this story, for example, is the evolution of this site to provide an effective means for documenting and deploying software.