Skip to content

Update QUICK_START.md to reflect current architecture #13

@danieljsinclair

Description

@danieljsinclair

Issue Type

Documentation Update

Severity

Medium - Outdated guidance

Problem Statement

QUICK_START.md references a verification system that doesn't exist in the current codebase. The document describes:

  • verification_tools/ directory
  • verification_system.sh script
  • ci_verification.sh script
  • test_cases.json configuration
  • Makefile targets for testing

None of these files exist in the repository.

Current Reality

The project uses:

  • GoogleTest for unit testing
  • CMake-based build system
  • CTest for running tests
  • test/ directory with unit/, integration/, and smoke/ subdirectories

Impact

  • Users following QUICK_START.md will encounter errors
  • Confusing guidance for new contributors
  • Outdated test execution instructions

Files Affected

  • docs/QUICK_START.md - Needs complete rewrite to reflect current test architecture

Recommended Actions

  1. Update QUICK_START.md to describe current GoogleTest/CMake setup
  2. Remove references to non-existent verification system
  3. Document actual test execution commands:
    • cmake --build build --target smoke_tests
    • cd build && ctest --output-on-failure
  4. Add guidance for running specific test suites
  5. Document test organization (unit, integration, smoke)

Acceptance Criteria

  • All references to verification_system.sh removed
  • Test execution commands are accurate for current build system
  • No references to non-existent files/directories
  • Guide works for new developers

Related Issues

References

  • Current test architecture: docs/TEST_ARCHITECTURE.md
  • Current build system: CMakeLists.txt (test/ directory)
  • Test framework: GoogleTest (already in dependency tree)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions