Skip to content

docs: make the battery the worked example - #43

Merged
LKSNDRTMLKV merged 3 commits into
stagingfrom
docs/quick-start-battery
Oct 27, 2026
Merged

LKSNDRTMLKV merged 3 commits into
stagingfrom
docs/quick-start-battery

Conversation

@LKSNDRTMLKV

@LKSNDRTMLKV LKSNDRTMLKV commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Summary

The docs site's quick start now publishes the same battery the engine README and dpp-core use: ops/demo/samples/battery-full.json, an industrial LFP battery with its Annex XIII content filled in, posted straight from the reader's dpp-engine clone. The deployment page drops the Caddy rewrite for the DID document, which the node no longer needs.

Changes

  • docs: make the battery the worked example: in quick-start.mdx, the operator is "Example Batteries GmbH", step 5 posts battery-full.json instead of an inline textile body and says why step 4 registered a facility and an operator identifier, and the DID document is fetched from /.well-known/did.json. In guides/import.mdx, the template example is battery-industrial.
  • docs: use the battery in the core overview: core/overview.mdx had the textile code example dpp-core's README used to have. It now carries the same battery example, byte-identical to the file that was run against the published 0.22.0 crates (valid against battery schema v2.8.0, signature verifies: true), and the remove-a-field line names batteryType.
  • docs: show the battery v2.10.0 quick start output: the core overview's expected output says battery schema v2.10.0, what dpp-core 0.23.0 will print. The same code run against core main prints exactly that.
  • docs: drop the DID proxy rewrite: engine/deployment.mdx proxies the node host without rewriting /.well-known/did.json. Since fix(node): serve the DID document at the root dpp-engine#518 the node serves its DID document at the root as well as under /identity.

How it was checked

The battery steps are the engine README's, and odal-node/dpp-engine#515 adds the_quick_start_battery_sample_creates_and_publishes, a Docker-tier smoke test. It registers the README's facility and operator identifier, then creates and publishes battery-full.json against a real node. It passes, stamps battery schema 2.8.0, and yields a carrier of the form /01/09506000134352/21/<serial>, as this page says. It fails when the default facility is missing.

Checklist

  • pnpm -r build and pnpm -r check
  • check:links (with anchors), check:llms, check:sitemaps, check:leakage, check:spacing, test:scripts
  • No secrets, credentials, or .env files in the diff
  • Founder review on the branch preview

Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Deploying odal-node-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: eb4b1f0
Status: ✅  Deploy successful!
Preview URL: https://7df558f9.odal-node-docs.pages.dev
Branch Preview URL: https://docs-quick-start-battery.odal-node-docs.pages.dev

View logs

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Deploying odal-node-landing with  Cloudflare Pages  Cloudflare Pages

Latest commit: eb4b1f0
Status: ✅  Deploy successful!
Preview URL: https://ff0146d6.odal-node-landing.pages.dev
Branch Preview URL: https://docs-quick-start-battery.odal-node-landing.pages.dev

View logs

Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
@LKSNDRTMLKV
LKSNDRTMLKV merged commit 3342a43 into staging Oct 27, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant