Repository navigation
docs: make the battery the worked example - #43
Merged
Merged
Conversation
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Deploying odal-node-docs with
|
| 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 |
Deploying odal-node-landing with
|
| 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 |
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
5 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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'sdpp-engineclone. 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: inquick-start.mdx, the operator is "Example Batteries GmbH", step 5 postsbattery-full.jsoninstead 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. Inguides/import.mdx, the template example isbattery-industrial.docs: use the battery in the core overview:core/overview.mdxhad 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 namesbatteryType.docs: show the battery v2.10.0 quick start output: the core overview's expected output saysbattery schema v2.10.0, what dpp-core 0.23.0 will print. The same code run against coremainprints exactly that.docs: drop the DID proxy rewrite:engine/deployment.mdxproxies 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 publishesbattery-full.jsonagainst 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 buildandpnpm -r checkcheck:links(with anchors),check:llms,check:sitemaps,check:leakage,check:spacing,test:scripts.envfiles in the diff