Skip to main content

Overview

Identity​

  • Project: jhf-wire
  • Category: bundle
  • Belongs to: Helpifyr Spindle through the bundle concept jhf-spindle-wire
  • Owner-Agent: jhf-wire-maintainer
  • Lifecycle: active

Purpose​

  • index page for the repository documentation set
  • short identity and orientation surface only
  • detailed runtime, integration, and Fabric semantics live in the linked documents below
  • secure transfer, submission-channel, and receipt-readback ownership for provider-facing bootstrap outputs stays bounded to jhf-wire

When You Need Wire​

Use jhf-wire when the stack needs:

  • connector/workflow bundle truth for the outbound provider lane
  • repo-owned workflow, integration, and runtime contract documentation
  • packaging, callback, and runtime verification for the jhf-wire stack
  • bounded operator-facing runbooks for sandbox-first provider flows

Do not use jhf-wire as the owner for Fabric governance semantics, upstream provider policy, or publisher/materialized public-docs ownership.

Doc Map​

  • Architecture: ARCHITECTURE.md
  • Runtime service flows: RUNTIME_SERVICE_FLOWS.md (docs/RUNTIME_SERVICE_FLOWS.md)
  • Public surfaces: PUBLIC_SURFACES.md (docs/PUBLIC_SURFACES.md)
  • Provider transfer and callback boundary: README.md and MODULE_FEATURES.md (docs/MODULE_FEATURES.md)
  • Runbook: RUNBOOK.md
  • Security: SECURITY.md
  • Operations: OPERATIONS.md
  • Integrations: INTEGRATIONS.md
  • Capabilities: CAPABILITIES.md
  • Fabric consumption: FABRIC_CONSUMPTION.md (docs/FABRIC_CONSUMPTION.md)
  • Fabric profile: FABRIC_TOOL_PROFILE.md (docs/FABRIC_TOOL_PROFILE.md)
  • API surfaces: API.md

Ownership Boundary​

jhf-wire owns:

  • workflow bundle and runtime contract truth for the jhf-wire lane
  • repo-owned packaging, callback, runtime, and integration documentation
  • operator-facing runbooks and verification scripts in this repository

jhf-wire does not own:

  • Fabric contract semantics
  • upstream provider policy or credentials
  • jhf-docs materialization or jhf-web publishing
  • unrelated host/runtime stacks outside the canonical jhf-wire boundary

Style Rules​

  • technical, exact wording only
  • no marketing language or filler
  • use the same terms consistently: Tool, Product, Service, Agent, Integration, Dependency
  • prefer short sections and short lists over long narrative text

Verify Path​

For a bounded repo-owned source-doc verification pass, run:

python scripts/validate_docs_platform_v1_6.py
python scripts/check_docs_inventory.py --strict
python scripts/check_fabric_contracts.py

License: AGPLv3 Project website: https://helpifyr.com

Docs Platform v1.6 Base Family​

  • README.md
  • docs/OVERVIEW.md
  • docs/INSTALL.md
  • docs/CONFIGURATION.md
  • docs/OPERATIONS.md
  • docs/TROUBLESHOOTING.md
  • docs/RELEASE_NOTES.md
  • docs_manifest.yml
  • docs/docs.manifest.yaml