Skip to content

docs(testing): categorize live parakeet integration tests in fdn-testing-guide #412

@Coldaine

Description

@Coldaine

Context: PR #410 added two `#[ignore]`-gated live integration tests that require a running `parakeet-cpu` docker-compose service. Today nothing in `docs/domains/foundation/fdn-testing-guide.md` or `CONTRIBUTING.md` marks these as a distinct category. Discoverability rides entirely on `just -l`.

Task: Add a section ("Level 3: External-service integration tests" or similar) that documents:

  • What they are and why they exist (complementary to stub-level unit tests)
  • How to run them locally: `just integration-parakeet`
  • Required dependencies: Docker / Docker Compose
  • That they are `#[ignore]` by default and never run in `cargo test`
  • Link to the test files and the compose file

Acceptance:

  • Section lands in `docs/domains/foundation/fdn-testing-guide.md`
  • `CONTRIBUTING.md` (or equivalent) cross-links to it
  • The `docs/whisper-model-configuration.md` / `stt-overview.md` family references the canonical parakeet-cpu model used by these tests (`parakeet-tdt-0.6b-v2`)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationkilo-duplicateAuto-generated label by Kilokilo-triagedAuto-generated label by Kilo

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions