OSS-first docs
These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.
GitHub Messaging
Use GitHub issue and pull request comments as an AI-native messaging channel with webhook verification, policy checks, and reliable outbound dispatch.
Required secrets and config
// secret payload
{
"token": "ghp_...",
"webhookSecret": "..."
}
// optional connection config
{
"defaultOwner": "lssm-tech",
"defaultRepo": "contractspec",
"apiBaseUrl": "https://api.github.com"
}Webhook ingress
- Inbound GitHub events are accepted on
/webhooks/github/events. - Signatures are checked using
x-hub-signature-256and the configured webhook secret. - Current normalization focuses on issue comment workflows and durable comment dispatch.
Workspace mapping
CHANNEL_WORKSPACE_MAP_GITHUB={"lssm-tech/contractspec":"workspace-acme"}
# Optional dev fallback (off by default)
CHANNEL_ALLOW_UNMAPPED_WORKSPACE=0Best practices
- Use a least-privileged token scoped for comment operations.
- Route repositories explicitly with workspace maps in multi-tenant environments.
- Keep dispatch endpoints protected with token or bearer auth.
Twilio integration
Handle messaging and telephony through typed transport boundaries and explicit configuration.
Contract reference
Browse the generated reference index for public contract surfaces, versions, and examples.
Why ContractSpec
Keep educational and comparison content reachable without letting it define the primary OSS learning path.