Docs hub

Public surfaces, no scavenger hunt.

This page links to the actual public assets and repo-shipped references that make up the current Proof of Ship surface, including the documented GitHub OAuth and repo-linking contract for public integrators.

Back to homepage

First-party hosted assets

/docs/schemas/ — hosted schema directory
/docs/examples/ — hosted example payloads
/docs/badges/ — hosted badge assets and embed snippets
/badges/verified.svg — verified badge
/favicon.svg — site icon

Repo references

GitHub account linking

Understand the contract before you build on it.

For public readers, the short version is: GitHub OAuth proves identity, repo linking proves a legitimate public-repository relationship, and neither one replaces independent receipt verification. The endpoints and payloads are documented today even though a broadly deployed first-party account UI is not claimed here yet.

Read the auth + linking guide Check current deployment status

Schemas

Examples

CLI quick hits

proofofship validate --json

proofofship badge verified <handle> --markdown

python scripts/validate_global_ledger.py --file examples/global-ledger.sample.jsonl