Reference·Overview

Reference overview

This docs site explains Blue through concepts and examples. It should not duplicate the normative specifications. Use this page as the short map to source material.

§Source of truth

The public specification repository is the source of truth for Blue 1.0 specifications:

  • Blue Language Specification 1.0
  • Blue Contracts and Processor Specification 1.0
  • Blue BEX Specification 1.0
  • Blue Coordination Package 1.0
  • Blue PayNote Package 1.0

Open the specification repository: bluecontract/blue-spec

The docs should link to this repository instead of hosting a copied specification page. A copied spec page will drift. A teaching page can explain concepts. A spec repository should define normative behavior.

§Implementation repositories

Use these repositories for implementation-facing behavior:

RepositoryUse it for
bluecontract/blue-language-javaParsing and serializing Blue YAML/JSON, resolving types and blueId references, schema validation, list controls, BlueId calculation, snapshots, patches, matching, and base processor foundations.
bluecontract/blue-bex-javaExecuting Blue Expression Objects as deterministic Blue-data programs that return values, changesets, events, gas, and metrics.
bluecontract/blue-coordination-javaRegistering and running executable Coordination contracts: operations, sequential workflows, Compute, document updates, triggered events, embedded scopes, checkpoints, and testable processing loops.
bluecontract/blue-jsTypeScript/JavaScript libraries for working with Blue content in Node.js and web-facing tooling.

§Example source

The flagship weekend package checkout example is embedded in the docs page:

Use the guided explanation first. Expand the full source block on that page when you need to inspect the complete reseller package document.

§Deeper reference

§What belongs in docs versus specs

Docs should answer:

  • Why does this concept exist?
  • What is the smallest useful example?
  • How do I read a real document that uses it?
  • What mistakes will I make when implementing it?
  • How does it connect to Counter and the weekend package checkout?

Specs should answer:

  • What is the normative algorithm?
  • Which inputs must be accepted or rejected?
  • What are the exact canonicalization rules?
  • What are the conformance requirements?
  • How should independent implementations prove compatibility?

Keep that boundary. It makes the docs friendlier and the specs more reliable.