Directory Structure

Project-friendly project organization for the introductory gamify experience.

_projects/gamify/
├── index.ipynb
├── levels/
│   ├── GameLevelWater.js
│   ├── GameLevelDesert.js
│   ├── GameLevelEnd.js
│   └── GameLevelOverworld.js
├── model/
├── images/
└── docs/
    └── README.md

Runtime/distributed outputs are generated into GitHub Pages folders by Makefile:

• _notebooks/projects/gamify/
• _posts/projects/gamify/
• assets/js/projects/gamify/
• images/projects/gamify/

Development Workflow

Primary SDLC workflow:

make dev

This is the main build-and-test loop for development. It starts Jekyll and the registered project watchers so edits are copied, converted, and regenerated automatically.

Validate this project after make dev when you want to force a full re-copy of distributed files.

Use this when:

• You renamed files or folders.
• You want to confirm files were copied to expected runtime directories.
• You want to isolate one project’s distribution behavior while debugging.

make -C _projects/gamify build
make -C _projects/gamify docs # docs are not in make dev

Validate all registered projects when you need a repo-wide distribution refresh or consistency check.

Use this when:

• Multiple projects were renamed or restructured.
• You want to verify all registered project outputs in one run.
• You want a quick pre-commit sanity check for project distribution.

make build-registered-projects
make build-registered-docs # docs are not in make dev

CI/CD Targets and Action Logs

GitHub Actions uses the same registered targets:

- name: Build registered projects
  run: |
    make build-registered-projects
    make build-registered-docs

Expected Actions log lines for project-level visibility:

• 📦 Building project: gamify
• 📚 Building docs for: gamify

If docs verification is enabled in workflow, expect summary lines similar to:

• Registered project docs found:
• Sample generated docs:

These logs are the quickest way to confirm _projects registration and distribution are running in CI.

Edit/Save Workflow

1. Edit files in _projects/gamify/
2. Save file and let auto-distribution run.
3. Jekyll regenerates affected pages.
4. Refresh browser and validate changes.

Path Guidance

Use runtime absolute paths in code.

// Image path from gameEnv
const sprite = gameEnv.path + '/images/projects/gamify/knight.png';

// Shared game engine import
import GameControl from '/assets/js/GameEnginev1.1/essentials/GameControl.js';

Registration Model

Project integration into Makefile is registration-based.

1. Add project name to _projects/.makeprojects.
2. Use the project Makefile template targets: build, clean, watch, docs, docs-clean.
3. For new projects, typically only DATE_OF_CREATION and project files change.

No Makefile fragments or project-specific root targets are required.

Version Control Strategy

Track source files in _projects. Treat distributed files as generated artifacts.

# Track source
!_projects/gamify/**

# Ignore generated distribution
_notebooks/projects/gamify/
assets/js/projects/gamify/
images/projects/gamify/
_posts/projects/gamify/

Notes

This OVERVIEW is the baseline introduction to the build system concepts. Real-world, deeper references belong in the cs-pathway docs.

For an example of lightweight team documentation, see the sample GameLevelWater write-up:

• Sample Level Documentation