Skip to main content

Documentation Index

Documentation Map​

Documentation Index

This page is the repo-owned navigation index for jhf-bobbin. It keeps the documentation spine readable for humans while making the publish posture of canonical docs, contracts, operations pages, runbooks, plans, and evidence explicit for the Helpifyr docs inventory rollout.

Canonical Docs​

Stable repository truth about what Bobbin is, what it owns, and how it fits in the Helpifyr stack.

  • Repo Landing Page
  • Overview
  • Install
  • Configuration
  • Release Notes
  • Architecture (docs/ARCHITECTURE.md)
  • API and Public Surfaces (docs/API.md)
  • Capabilities (docs/CAPABILITIES.md)
  • Module Feature Registry (docs/MODULE_FEATURES.md)
  • Integrations (docs/INTEGRATIONS.md)
  • Memory Runtime and Recall Flows (docs/MEMORY_RUNTIME_AND_RECALL_FLOWS.md)
  • Stack Relationships (docs/STACK_RELATIONSHIPS.md)

Contracts​

Normative runtime, compatibility, policy-boundary, and export truth.

  • Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
  • Stack Container Contract (docs/STACK_CONTAINER_CONTRACT.md)
  • OSS Inventory Version Truth (docs/OSS_INVENTORY.md)
  • Compatibility Matrix (docs/COMPATIBILITY_MATRIX.md)
  • Contract Governance (docs/CONTRACT_GOVERNANCE.md)
  • CLI Contract (docs/CLI_CONTRACT.md)
  • Fabric Read Contract (docs/FABRIC_READ_CONTRACT.md)
  • Fabric Status Bundle (docs/FABRIC_STATUS_BUNDLE.md)
  • Artifact Contract (docs/ARTIFACT_CONTRACT.md)
  • Support Recall Contract (docs/SUPPORT_RECALL_CONTRACT.md)
  • Dobby Marked Provenance Contract (docs/DOBBY_MARKED_PROVENANCE_CONTRACT.md)
  • Memory Policy and Claims Consumption (docs/MEMORY_POLICY_AND_CLAIMS_CONSUMPTION.md)
  • Event Modeling Wave 4 Adoption (docs/EVENT_MODELING_WAVE4_ADOPTION.md)

Operational Docs​

Maintained operator guidance for setup, verification, security, release, and runtime posture.

  • Operations
  • Setup (docs/SETUP.md)
  • Security (docs/SECURITY.md)
  • Standalone Verification Profile (docs/STANDALONE_VERIFICATION_PROFILE.md)
  • Host Access Prerequisites (docs/HOST_ACCESS_PREREQUISITES.md)
  • OpenClaw Plus Tests (docs/OPENCLAW_PLUS_TESTS.md)
  • Release Readiness (docs/RELEASE_READINESS.md)
  • Release Checklist (docs/RELEASE_CHECKLIST.md)
  • Packaging (docs/PACKAGING.md)
  • Healthcheck Hardening (docs/HEALTHCHECK_HARDENING.md)
  • Update Strategy (docs/UPDATE_STRATEGY.md)
  • Operator Handover (docs/OPERATOR_HANDOVER.md)
  • CI Decisions (docs/CI_DECISIONS.md)

Runbooks​

Repeatable operator procedures and recovery paths.

  • Runbook
  • Deploy, Verify, and Recovery (docs/DEPLOY_VERIFY_AND_RECOVERY.md)
  • Troubleshooting
  • Gitea Publish (docs/GITEA_PUBLISH.md)

Docs Platform v1.6 Base Family​

The canonical docs platform base family for jhf-bobbin is:

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

Plans​

Forward-looking adoption, backlog, and scope decisions. These are useful, but they must not compete with current runtime truth.

  • Autonomous Backlog (docs/AUTONOMOUS_BACKLOG.md)
  • Roadmap (docs/ROADMAP.md)
  • Fabric Enablement Task (docs/FABRIC_ENABLEMENT_TASK.md)
  • Fabric Wave 3 Adoption (docs/FABRIC_WAVE3_ADOPTION.md)
  • Fabric JARVIS Adoption (docs/FABRIC_JARVIS_ADOPTION.md)
  • Event Modeling Wave 4 Adoption (docs/EVENT_MODELING_WAVE4_ADOPTION.md)
  • Voice Memory Follow-up Decision (docs/VOICE_MEMORY_FOLLOWUP_DECISION.md)

Evidence And Historical Material​

These pages preserve proof or history. They are intentionally published conservatively and should not be treated as canonical steady-state docs.

  • Release Cadence Evidence (docs/RELEASE_CADENCE_EVIDENCE.md)
  • Naming Migration Audit (docs/NAMING_MIGRATION_AUDIT.md)
  • Solution Overview (DE) (docs/SOLUTION_OVERVIEW_DE.md)
  • Sales Notes (docs/SALES_NOTES.md)
  • Archived Local Issue Notes

Documentation Rules​

  • Bobbin must not create local shadow truth for Fabric-owned policy, lifecycle, or closure semantics.
  • Runtime examples may describe patterns and commands, but canonical live host values belong in operator flows, not in the README landing page.
  • Evidence, plans, and archives must stay classified conservatively for Wiki.js publication.

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.