Loom Core docs
Source and Publish Paths
Flexinfer Site Integration
This repository (services/loom-core) is the source of truth for Loom Core docs that are published on https://flexinfer.ai via the services/flexinfer-site repository.
Source and Publish Paths
- Source docs in this repo:
docs/ - Site content target in
services/flexinfer-site:content/loom-core-docs/ - Public route on site:
/docs/loom-core
The sync mapping is defined in:
services/flexinfer-site/scripts/sync-docs.mjsname: 'loom-core'source: '../loom-core/docs'target: 'content/loom-core-docs'
Publish Workflow
From services/flexinfer-site:
pnpm sync:loom-core-docs
pnpm lint
pnpm test
pnpm build
Then open a PR in services/flexinfer-site and deploy through its normal pipeline.
Authoring Rules in loom-core
When you change user/developer-facing behavior in services/loom-core:
- Update docs under
docs/andCHANGELOG.mdin this repo. - Run guardrails in this repo:
bash scripts/ci/check_docs_guardrails.shbash scripts/ci/check_flexinfer_site_integration.sh
- Sync and publish in
services/flexinfer-siteusingpnpm sync:loom-core-docs.
CI and Pre-commit Enforcement
This repo enforces the site integration contract in:
- Pre-commit hooks (
.pre-commit-config.yaml) - Local CI guardrails (
make ci-guardrails) - GitLab CI guardrails job (
guardrails:docs-cli) - GitHub Actions CI guardrails step
The integration guardrail script validates:
- This runbook exists and includes required sync details.
- If a sibling
services/flexinfer-sitecheckout exists, its sync mapping forloom-coreis still correct.