Contribute

Where content belongs

Content	Repository
Atomicals protocol, ARC-20, NFTs, Containers, Realms, AVM, AIPs	This repository
Public developer and API documentation for Universe Atomicals services	This repository
Public schemas, OpenAPI, examples, source ledger, conformance, LLM files, MCP package	This repository
Private architecture, deployment, credentials handling, capacity, monitoring, recovery	docs-dev-atomicals and docs-dev-atomicals-nfts-and-realms
Core-specific user workflows	docs-core
Inscribe-specific product workflows	docs-inscribe

What must never appear here

Passwords, tokens, private keys, seed phrases, bearer credentials, HMAC secrets, private RPC URLs, private indexer origins, SSH endpoints, private hostnames, database credentials, internal network topology, recovery secrets, operator-only command history, or customer data. Secret scanning runs in CI, and it is the last line, not the first.

The one rule that matters most

Never present protocol behavior and Universe behavior as the same thing. Every page declares its applicability in frontmatter, and that declaration drives the panel readers see.

Quick start

npm install
npm run generate
npm run check
npm test
npm run build

npm run generate regenerates every derived artefact. If it changes a committed file, commit that change: CI fails when generation leaves the repository dirty.

• Content model

  Every frontmatter field, what it means, and what it must be true of.

• Adding an API

  Route inventory, OpenAPI, schemas, examples, and the checks that bind them.

• Conformance vectors

  How to add an executed case that the prose and the tools both use.

• Translations

  The required page set, the glossary, and how staleness is detected.

• Ecosystem records

  What evidence a record needs before it is merged.

• Releasing

  The gates, in order, and what each one proves.

Reporting a problem

Template	Use it for
Documentation defect	A typo, a broken link, an unclear passage
Incorrect protocol claim	A statement that does not match the source
API mismatch	A documented route that does not match the runtime
Translation defect	A wrong or stale translation
Accessibility defect	Anything that fails WCAG 2.2 AA
Broken external integration	A link or an ecosystem record that is wrong
New AIP	A proposal to add to the register
Source version update	A pinned revision that should move

Include the page ID from the source panel. It is stable across locales and versions.