Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.15 KB

docs-sync.md

File metadata and controls

39 lines (26 loc) · 1.15 KB

Docs Sync Contract

This repository is the canonical source for public SMALL documentation.

Integration model

  • Model A: vendored canonical docs into docs site repo (smallprotocol.dev)

Canonical path mapping

  • docs/installation.md -> smallprotocol.dev/app/modules/docs/content/canonical/installation.md
  • docs/quickstart.md -> smallprotocol.dev/app/modules/docs/content/canonical/quickstart.md
  • docs/maintainers/releasing.md -> smallprotocol.dev/app/modules/docs/content/canonical/releasing.md
  • docs/maintainers/release-checklist.md -> smallprotocol.dev/app/modules/docs/content/canonical/release-checklist.md
  • spec/small/v1.0.0/ -> smallprotocol.dev/vendor/small-protocol/spec/small/v1.0.0/

Sync command

Run from smallprotocol.dev:

bash scripts/sync-small-protocol-docs.sh

This performs:

  1. spec vendor sync (scripts/sync-spec.sh)
  2. canonical docs copy (scripts/sync-canonical-docs.sh)
  3. docs registry regeneration (bun run generate-content-registry)

Required verification gates

Run from smallprotocol.dev:

bash scripts/check-canonical-docs.sh
bash scripts/check-spec-vendor.sh
bun run build