Skip to content

05 — Repo Map and Folder Guide

Related chapters: 04 — Repo, Git, and GitHub Orientation · 06 — Product Architecture · 03 — Master Terminology Dictionary

This chapter is a quick map of the repo.

The goal is not to memorize every folder. The goal is to know what kind of place each major folder is.


The simplest way to picture the repo

SUMMA repo
│
├── product architecture
├── training and manuals
├── memory / continuity files
└── docs site / published reading layer

The main zone to know first

summa_crim/

Think of summa_crim/ as one of the main homes of the SUMMA criminal-review system.

It contains three major things the reader should care about:

summa_crim/
│
├── internal_training_manual/   -> the main company manual
├── luke_training/              -> earlier training/source material
└── casecards/                  -> one of the engine rooms

What each zone means

1. internal_training_manual/

What it is:
The main company-style manual.

Why it matters:
This is where a new team member should learn the system properly.


2. luke_training/

What it is:
Earlier training material and source teaching material.

Why it matters:
It still matters, but it is no longer the main front door.


3. casecards/

What it is:
A major architecture lane where the file starts becoming structured objects instead of just a pile of documents.

Why it matters:
This is one of the engine rooms of the product.


Other important repo ideas

README anchor files

What they are:
Files that preserve project memory, decisions, and safe restart points.

Simple meaning:
They help the project remember itself.


Docs site

What it is:
The website version of the manual.

Simple meaning:
The readable online form of the training docs.


Markdown

What it is:
A simple writing format used for structured text.

Simple meaning:
The source writing format for the manual.


MkDocs

What it is:
A tool that turns Markdown files into a docs website.

Simple meaning:
It builds the manual site.


Netlify

What it is:
A hosting service that publishes the docs site online.

Simple meaning:
It puts the built manual on the web.


One important distinction

source file     -> the file humans edit
generated file  -> the output a tool creates

Example:

chapter.md      -> source
site/ output    -> generated

Do not confuse the two.


The practical map

product architecture   -> where the machine logic lives
training/manuals       -> where the system is explained
memory/continuity      -> where restart context lives
docs/output            -> where readable published output lives

Final takeaway

The repo is not random.

It is a building with different rooms.

The reader does not need to know every room yet. The reader only needs to know what kind of room they are in.