Skip to content

About

The Bitcoin Universe documentation platform: portal, design system, content schemas, search, and release tooling for docs.bitcoinuniverse.io

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

docs-platform

The Bitcoin Universe documentation platform: the portal at docs.bitcoinuniverse.io, its design system, content schemas, source pinning, and release tooling.

How it works

The portal builds its pages from content in this repository and from the local ecosystem registry. The source registry and lock file track repositories and their manifests, but the portal build does not currently ingest their checked-out content. Some documentation repositories are unpublished templates without manifests; do not assume they feed the portal.

Separately, tooling/sync can validate manifests, pin source commits in sources.lock.json, and fetch those commits for inspection. A repository without a valid manifest cannot be locked by this tool. The existing lock is a historical snapshot, not evidence that its sources are included in the portal build.

Workspace

Path What it is
apps/portal The public documentation portal
packages/design-system Shared theme, tokens, and build helpers for documentation surfaces
packages/content-schema The docs.manifest.json schema, TypeScript types, and a zero-dependency validator
packages/ecosystem-registry Protocol, product, and chain data, plus the capability snapshot generated from Core
tooling/sync Pinned-source synchronization: lock, fetch, verify

Where capability claims come from

The Protocol Atlas and the product pages are generated from packages/ecosystem-registry, not hand-written. Its capability-snapshot.json is produced from the protocol registry inside the private core repository and records the exact Core commit it came from, so every support claim on the portal traces back to product code rather than to a maintainer's memory.

node packages/ecosystem-registry/bin/generate-capability-snapshot.mjs --core /path/to/core

The generator refuses to write a snapshot containing anything that looks like a host, address, credential, or filesystem path. Capability truth is public; infrastructure detail is not.

Two rules are enforced by tests rather than by review:

  • A surface never advertises an action the protocol's own marketplace policy marks unsupported. Without this, a page claims a capability it denies further down.
  • Every unsupported action carries the reason recorded in the registry. The reason is the useful part; a table of ticks teaches nothing.

Develop

pnpm install
pnpm test          # workspace test suites
pnpm --filter @universe/docs-portal dev

Validate a manifest from any repository, with bare Node and no install:

node packages/content-schema/bin/validate-manifest.mjs path/to/docs.manifest.json

Pin, fetch, and verify sources (uses GH_TOKEN when set):

pnpm sync:lock
pnpm sync:fetch
pnpm sync:verify

Branches and release

CI runs on pushes to main and develop and on pull requests. The production workflow targets main, verifies the pinned manifests, and builds the portal at the triggering commit. A push to main can initiate a production deployment, subject to the production environment’s protections.

Core's assisted-action documentation is a development preview. Before publishing its coordinated update, verify the released Core behavior and pin the published docs-core commit through the existing sync tooling. Local implementation commits must not advance sources.lock.json or generated capability snapshots. Agent read tools do not enable new marketplace, signing or inscription capabilities.

develop is the working branch. Production deployments build only from the explicitly configured production ref with a verified sources.lock.json; every deployment records the exact portal commit and source commits it was built from.

Contributing

See the organization CONTRIBUTING.md and documentation conventions. Vulnerabilities go through private reporting per SECURITY.md.

License

MIT for platform code in this repository. Ingested documentation content remains under its source repository's license.

About

The Bitcoin Universe documentation platform: portal, design system, content schemas, search, and release tooling for docs.bitcoinuniverse.io

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages