Skip to content
Live

The documentation repository describes the protocol as it is. A record is where a decision gets made; the prose only reports it.

nuvex-docs on GitHub

Repository

nuvex-docs

Path

architecture/adr/, oracle/, sdk/

Language

Markdown, TypeScript

Records

ADR 0001 to ADR 0007

What lives here

The tree covers introduction, oracle (vrf, data, price, callbacks, ai), architecture, verification, sdk (index, rust, typescript, cli, cpi), nodes (installation, configuration, staking, rewards, slashing), security (index, threat-model), developers (index, quick-start) and api. Decision records sit under architecture/adr/.

“Do not document an instruction, fee, or job that the protocol repository has not implemented.”
.github/CONTRIBUTING.md, documentation repository

Pages about a later milestone exist, and they say which milestone they are waiting on. A page that reads as if the feature shipped is a defect even when the design is right.

A first contribution

  • Correct a page that describes an instruction differently from the program that implements it.
  • Add the milestone label to a page that promises behaviour the protocol does not have yet.
  • Write the consequences section of a record that only states a decision.
  • Record a rejected alternative that a reviewer had to explain twice in a pull request.

A new decision record is numbered after ADR 0007 and needs a status line, a context, the decision, its consequences and the alternatives it rejects.

Checks that must pass

The documentation repository runs its own four commands:

pnpm install
pnpm format:check
pnpm lint
pnpm typecheck
  • Every factual sentence has to be traceable to the protocol repository, not to a plan.
  • A claim about a status belongs next to the status line of the record it came from.
  • The development server for the documentation site listens on port 3001, not 3000.

Decisions that are closed

  • Maintainers are not named in the repository, and documentation does not name them either.
  • The read API, the indexer and the dashboard are not sources of protocol truth. Solana account state is authoritative.
  • No audit has been commissioned. security/AUDIT_SCOPE.md is a scope, not a report.
  • Nothing is deployed to mainnet, so no page may give a mainnet address.