Quick Start

Docs Index

This index is the canonical short entrypoint for jhf-spindle documentation.

Core Orientation

• Overview
• Install
• Configuration
• Operations
• Troubleshooting
• Release Notes
• Architecture
• Stack Contract (docs/STACK_CONTRACT.md)
• Integrations

Active Target Plans

• PROJECT_PLAN.md
• CRM v8 Target Plan (docs/plans/PLAN_SPINDLE_FRAPPECRMv8.md)
• CRM v8 Execution Goal (docs/plans/GOAL_SPINDLE_FRAPPECRMv8_EXECUTION.md)
• Plan Studio Context Surface (docs/PLAN_STUDIO_CONTEXT_SURFACE.md)

CRM Governance

• CRM Customization Governance (docs/CRM_CUSTOMIZATION_GOVERNANCE.md)
• CRM Import Lane (docs/CRM_IMPORT_LANE.md)
• CRM MCP Facade (docs/CRM_MCP_FACADE.md)
• CRM Privacy And Consent (docs/CRM_PRIVACY_CONSENT.md)

Documentation Classes

The repo still separates documentation into three primary truth classes:

• business-truth
  • runtime/domain behavior and operator-facing understanding
  • examples: README.md, docs/OVERVIEW.md, docs/ARCHITECTURE.md
• contracts
  • machine-readable protocol/contract surfaces
  • examples: docs/contracts/*.json
• plans
  • execution plans, rollout plans, and acceptance-tracking pages
  • conservative publish by default (summary, link_only, or never)

Publishing Posture

Conservative publishing posture:

• historical/evidence pages are not full-published
• acceptance-heavy pages are link-first unless explicitly promoted
• see docs/docs.manifest.yaml for canonical class/policy rules

---

License notice: AGPLv3 (GNU Affero General Public License v3.0) Website: https://helpifyr.com