Skip to content

Docs: Add missing BloodCell import to circulatory quick start #54

@kluth

Description

@kluth

Problem

The Circulatory System quick start example uses BloodCell but doesn't show it in the import statement.

Affected Files

Documentation: /home/matthias/projects/synapse/docs/systems/circulatory/README.md (lines 382-413)

Issue Details

Severity: HIGH
Impact: Copy-paste code will not compile

Current (Incomplete) Import

import { Heart, PublishSubscribe, RequestResponse } from '@synapse-framework/core';

Code Uses BloodCell Without Importing

const cell = new BloodCell(...);  // Error: BloodCell is not defined!

Required Fix

import {
  Heart,
  PublishSubscribe,
  RequestResponse,
  BloodCell  // ADD THIS
} from '@synapse-framework/core';

Impact

Users copying the quick start code will encounter ReferenceError: BloodCell is not defined or TypeScript compilation errors.

Priority

HIGH - Fix this sprint. Quick start is primary entry point for new users.

References

  • Documentation Issue Log: /home/matthias/projects/synapse/DOCUMENTATION_ISSUE_LOG.md (Issue ci: Bump actions/upload-artifact from 4 to 5 #6)
  • Documentation Fixes Needed: /home/matthias/projects/synapse/DOCUMENTATION_FIXES_NEEDED.md (FIX-3)

User Story

As a new user, I want complete import statements in code examples, so that I can copy and run the quick start code without missing dependency errors.

Acceptance Criteria

  • Add BloodCell to import statement
  • Verify all used classes are imported
  • Test that quick start code compiles
  • Check for similar issues in other quick start examples

Labels

This is a good first issue for new contributors - simple documentation fix with clear solution.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationgood first issueGood for newcomershighHigh priority - fix this sprint

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions