Skip to content

PUBLISH.md

Latest commit

 

History

History
23 lines (19 loc) · 1.15 KB

PUBLISH.md

File metadata and controls

23 lines (19 loc) · 1.15 KB
Raw

Publishing this repo

This folder is safe to open-source: it contains only interface docs, request/response schemas, and thin HTTP client SDKs. It contains no Validiti engine, no source, no internal module names, and no explanation of how any of it works — only how to call it.

To publish

From inside this folder:

git init && git add -A && git commit -m "Validiti developer docs v1 (preview)"
# create an EMPTY public repo (e.g. github.com/validiti/developers), then:
git remote add origin git@github.com:validiti/developers.git
git branch -M main && git push -u origin main

Before you push — the checklist that matters

  • No file references a private codebase path or an internal engine module.
  • No file describes how the substrate works internally (outcomes and interfaces only).
  • The SDKs are pure HTTP — they call the API and contain none of our logic.
  • Live keys and real base URLs are not committed (they ship per-agreement, not in git).

If in doubt, review each file by hand — this repo is small on purpose. The rule is simple: a reader learns exactly how to call Validiti, and nothing about how it is built.