Skip to content

Commit 38565c1

Browse files
committed
fix(docs): check validation
1 parent d1f890d commit 38565c1

File tree

4 files changed

+35
-40
lines changed

4 files changed

+35
-40
lines changed

docs/src/architecture/08_concepts/signed_doc/voting_process/drep_delegation_and_discovery.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,9 @@ and how these documents are discovered and validated in a decentralized pub/sub
1313

1414
## Documents and Roles
1515

16-
* Rep Profile: the representative’s global profile under a brand.
17-
See: [Rep Profile](../docs/rep_profile.md).
18-
* Rep Nomination: contest-specific nomination under contest parameters.
19-
See: [Rep Nomination](../docs/rep_nomination.md).
20-
* Contest Delegation: voter delegation to one or more representatives (nominations) for a contest.
21-
See: [Contest Delegation](../docs/contest_delegation.md).
16+
* Rep Profile: the representative’s global profile under a brand. See: [Rep Profile](../docs/rep_profile.md).
17+
* Rep Nomination: contest-specific nomination under contest parameters. See: [Rep Nomination](../docs/rep_nomination.md).
18+
* Contest Delegation: voter delegation to one or more representatives (nominations) for a contest. See: [Contest Delegation](../docs/contest_delegation.md).
2219

2320
Signers:
2421

@@ -40,11 +37,9 @@ Signers:
4037

4138
### Delegation Semantics
4239

43-
* Multiple Delegates: voters may delegate to multiple representatives for a contest (ordered by priority).
44-
See: [Contest Delegation](../docs/contest_delegation.md).
40+
* Multiple Delegates: voters may delegate to multiple representatives for a contest (ordered by priority). See: [Contest Delegation](../docs/contest_delegation.md).
4541
* Weights: optional payload weights distribute the voter’s (post-scaling) voting power proportionally;
46-
non-positive weights are treated as 1.
47-
Remainders go to the highest-priority delegate.
42+
non-positive weights are treated as 1. Remainders go to the highest-priority delegate.
4843
* Insufficient Power: if voting power is insufficient to distribute to all delegates, lower-priority delegates may receive 0.
4944
* Revocation: [`metadata.revocations`](../metadata.md#revocations) can withdraw a delegation
5045
(set to `true` to withdraw all versions), or a new delegation supersedes the prior one
@@ -65,19 +60,19 @@ that anchors the document via [`metadata.parameters`](../metadata.md#parameters)
6560
### Consumer Pipeline
6661

6762
1. Rep Profile intake (by brand)
68-
* Verify signature (`Representative`), `metadata.template`,
69-
[`metadata.parameters`](../metadata.md#parameters) (brand), and payload schema.
63+
* Verify signature (`Representative`), `metadata.template`,
64+
[`metadata.parameters`](../metadata.md#parameters) (brand), and payload schema.
7065
2. Rep Nomination intake (by contest)
71-
* Verify signature (`Representative`), [`metadata.ref`](../metadata.md#ref) to Rep Profile,
72-
[`metadata.parameters`](../metadata.md#parameters) (contest), and template/payload validity.
73-
* Track the latest valid nomination per (representative, contest), excluding revoked items.
66+
* Verify signature (`Representative`), [`metadata.ref`](../metadata.md#ref) to Rep Profile,
67+
[`metadata.parameters`](../metadata.md#parameters) (contest), and template/payload validity.
68+
* Track the latest valid nomination per (representative, contest), excluding revoked items.
7469
3. Contest Delegation intake (by contest)
75-
* Verify signature (`Registered`), [`metadata.ref`](../metadata.md#ref) to one or more nominations,
76-
[`metadata.parameters`](../metadata.md#parameters) (contest), and payload (weights) schema.
77-
* For multiple references, ignore any invalid nominations;
78-
consider the delegation valid if at least one referenced nomination is valid.
79-
* Maintain the latest delegation per (delegator, contest);
80-
apply [`metadata.revocations`](../metadata.md#revocations) when present.
70+
* Verify signature (`Registered`), [`metadata.ref`](../metadata.md#ref) to one or more nominations,
71+
[`metadata.parameters`](../metadata.md#parameters) (contest), and payload (weights) schema.
72+
* For multiple references, ignore any invalid nominations;
73+
consider the delegation valid if at least one referenced nomination is valid.
74+
* Maintain the latest delegation per (delegator, contest);
75+
apply [`metadata.revocations`](../metadata.md#revocations) when present.
8176

8277
### Effective Delegation Set
8378

docs/src/architecture/08_concepts/signed_doc/voting_process/voting_bulletin_board_and_pubsub_tally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ and how ballots and checkpoints are discovered, validated, and tallied in a dece
4040
* Payload contains `smt-root` (BLAKE3-256 digest) and `smt-entries` (count).
4141
* Checkpoints are chained via `metadata.chain`; the final checkpoint height is negated.
4242
* Typically anchored to a blockchain (e.g., encoded `document_ref` in on-chain metadata signed
43-
by the operator) to provide an immutable timestamped anchor.
43+
by the operator) to provide an immutable timestamped anchor.
4444

4545
### Validation (Consumer)
4646

specs/generators/pages/signed_doc/voting_process/drep_delegation_and_discovery.md.jinja

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,26 +60,26 @@ that anchors the document via [`metadata.parameters`](../metadata.md#parameters)
6060
### Consumer Pipeline
6161

6262
1. Rep Profile intake (by brand)
63-
* Verify signature (`Representative`), `metadata.template`,
64-
[`metadata.parameters`](../metadata.md#parameters) (brand), and payload schema.
63+
* Verify signature (`Representative`), `metadata.template`,
64+
[`metadata.parameters`](../metadata.md#parameters) (brand), and payload schema.
6565
2. Rep Nomination intake (by contest)
66-
* Verify signature (`Representative`), [`metadata.ref`](../metadata.md#ref) to Rep Profile,
67-
[`metadata.parameters`](../metadata.md#parameters) (contest), and template/payload validity.
68-
* Track the latest valid nomination per (representative, contest), excluding revoked items.
66+
* Verify signature (`Representative`), [`metadata.ref`](../metadata.md#ref) to Rep Profile,
67+
[`metadata.parameters`](../metadata.md#parameters) (contest), and template/payload validity.
68+
* Track the latest valid nomination per (representative, contest), excluding revoked items.
6969
3. Contest Delegation intake (by contest)
70-
* Verify signature (`Registered`), [`metadata.ref`](../metadata.md#ref) to one or more nominations,
71-
[`metadata.parameters`](../metadata.md#parameters) (contest), and payload (weights) schema.
72-
* For multiple references, ignore any invalid nominations;
73-
consider the delegation valid if at least one referenced nomination is valid.
74-
* Maintain the latest delegation per (delegator, contest);
75-
apply [`metadata.revocations`](../metadata.md#revocations) when present.
70+
* Verify signature (`Registered`), [`metadata.ref`](../metadata.md#ref) to one or more nominations,
71+
[`metadata.parameters`](../metadata.md#parameters) (contest), and payload (weights) schema.
72+
* For multiple references, ignore any invalid nominations;
73+
consider the delegation valid if at least one referenced nomination is valid.
74+
* Maintain the latest delegation per (delegator, contest);
75+
apply [`metadata.revocations`](../metadata.md#revocations) when present.
7676

7777
### Effective Delegation Set
7878

7979
* For a given contest, compute the effective set by:
80-
* Taking each delegator’s latest valid delegation.
81-
* Filtering delegates to those with a latest valid nomination.
82-
* Applying weights and priority, using integer division and remainder assignment to the highest priority.
80+
* Taking each delegator’s latest valid delegation.
81+
* Filtering delegates to those with a latest valid nomination.
82+
* Applying weights and priority, using integer division and remainder assignment to the highest priority.
8383

8484
## Validation Summary
8585

specs/generators/pages/signed_doc/voting_process/voting_bulletin_board_and_pubsub_tally.md.jinja

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ and how ballots and checkpoints are discovered, validated, and tallied in a dece
3737
* Role: produced periodically by the bulletin board operator (admin role: “Bulletin Board Operator”).
3838
* Purpose: commits a merklized summary (Sparse Merkle Tree, SMT) of the ballots collected since the
3939
previous checkpoint.
40-
* Payload contains `smt-root` (BLAKE3-256 digest) and `smt-entries` (count).
41-
* Checkpoints are chained via `metadata.chain`; the final checkpoint height is negated.
42-
* Typically anchored to a blockchain (e.g., encoded `document_ref` in on-chain metadata signed
43-
by the operator) to provide an immutable timestamped anchor.
40+
* Payload contains `smt-root` (BLAKE3-256 digest) and `smt-entries` (count).
41+
* Checkpoints are chained via `metadata.chain`; the final checkpoint height is negated.
42+
* Typically anchored to a blockchain (e.g., encoded `document_ref` in on-chain metadata signed
43+
by the operator) to provide an immutable timestamped anchor.
4444

4545
### Validation (Consumer)
4646

0 commit comments

Comments
 (0)