Skip to content

Fix build system project directory mismatch #22

@gerchowl

Description

@gerchowl

Problem Description

The build system has a structural inconsistency where the project name doesn't match the actual source directory, causing build failures.

Current Behavior

  • The Makefile defines PROJECT ?= technical-documentation (line 8)
  • But the actual documentation source is in /workspace/docs/ directory
  • The build-diagrams.py script expects the project directory at /workspace/technical-documentation/
  • This causes the build to fail with: Error: project directory not found at /workspace/technical-documentation

Root Cause

There are three build-related directories:

  1. /workspace/build/ - Used by Makefile for main project outputs ✅
  2. /workspace/technical-documentation/build/ - Orphaned/unused directory ❌
  3. /workspace/example/build/ - Used by Makefile for example project ✅

The inconsistency:

  • Project name: technical-documentation
  • Source directory: docs/
  • Expected by scripts: technical-documentation/

Proposed Solution

Update the Makefile to use "docs" as the project name to match the actual directory structure:

  • Change PROJECT ?= technical-documentation to PROJECT ?= docs
  • Update the technical-documentation target to pass PROJECT=docs to build-project

This aligns the project name with the actual source directory location.

Files Affected

  • /workspace/Makefile (lines 8, 46)

Impact

  • Low risk: Only changes project name reference
  • No changes to output file names or locations
  • Diagrams will correctly compile from docs/diagrams/
  • The orphaned technical-documentation/ folder can be safely removed in a follow-up

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions