From 95169c8829623f8ae6b7fc65b6f15a000880425c Mon Sep 17 00:00:00 2001 From: bgallois <benjamin@gallois.cc> Date: Fri, 29 Nov 2024 15:41:06 +0100 Subject: [PATCH] reference rust doc in readme --- client/distance/README.md | 3 +++ distance-oracle/README.md | 3 +++ node/README.md | 3 +++ pallets/README.md | 28 ++++++++++++++-------------- runtime/README.md | 6 +++--- 5 files changed, 26 insertions(+), 17 deletions(-) create mode 100644 client/distance/README.md create mode 100644 distance-oracle/README.md create mode 100644 node/README.md diff --git a/client/distance/README.md b/client/distance/README.md new file mode 100644 index 000000000..dff4c144c --- /dev/null +++ b/client/distance/README.md @@ -0,0 +1,3 @@ +# Distance Oracle Inherent Data Provider + +You can find the autogenerated documentation at: [https://doc-duniter-org.ipns.pagu.re/dc_distance/index.html](https://doc-duniter-org.ipns.pagu.re/dc_distance/index.html). diff --git a/distance-oracle/README.md b/distance-oracle/README.md new file mode 100644 index 000000000..169549017 --- /dev/null +++ b/distance-oracle/README.md @@ -0,0 +1,3 @@ +# Distance Oracle + +You can find the autogenerated documentation at: [https://doc-duniter-org.ipns.pagu.re/distance_oracle/index.html](https://doc-duniter-org.ipns.pagu.re/distance_oracle/index.html). diff --git a/node/README.md b/node/README.md new file mode 100644 index 000000000..a365610b2 --- /dev/null +++ b/node/README.md @@ -0,0 +1,3 @@ +# Duniter Node + +You can find the autogenerated documentation at: [https://doc-duniter-org.ipns.pagu.re/duniter/index.html](https://doc-duniter-org.ipns.pagu.re/duniter/index.html). diff --git a/pallets/README.md b/pallets/README.md index e25c7907f..1c7abcfbb 100644 --- a/pallets/README.md +++ b/pallets/README.md @@ -6,20 +6,20 @@ Duniter uses some [parity pallets](https://github.com/duniter/substrate/tree/mas These pallets are at the core of Duniter/Ğ1 currency -- **`authority-members`** Duniter authorities are not selected with staking but through a smith web of trust. -- **`certification`** Certifications are the "edges" of Duniter's dynamic directed graph. They mean the acceptation of a Licence. -- **`duniter-account`** Duniter customized the `AccountData` defined in the `Balances` pallet to introduce a `linked_idty`. -- **`duniter-wot`** Merges identities, membership, certifications and distance pallets to implement Duniter Web of Trust. -- **`distance`** Publishes median of distance computation results provided by inherents coming from `distance-oracle` workers. -- **`identity`** Identities are the "nodes" of Duniter's dynamic directed graph. They are one-to-one mapping to human being. -- **`membership`** Membership defines the state of identities. They can be member or not of the different WoTs. -- **`universal-dividend`** UD is at the basis of Ğ1 "libre currency". It is both a kind of "basic income" and a measure unit. +- **[`authority-members`](https://doc-duniter-org.ipns.pagu.re/pallet_authority_members/index.html)** Duniter authorities are not selected with staking but through a smith web of trust. +- **[`certification`](https://doc-duniter-org.ipns.pagu.re/pallet_certification/index.html)** Certifications are the "edges" of Duniter's dynamic directed graph. They mean the acceptation of a Licence. +- **[`duniter-account`](https://doc-duniter-org.ipns.pagu.re/pallet_duniter_account/index.html)** Duniter customized the `AccountData` defined in the `Balances` pallet to introduce a `linked_idty`. +- **[`duniter-wot`](https://doc-duniter-org.ipns.pagu.re/pallet_duniter_wot/index.html)** Merges identities, membership, certifications and distance pallets to implement Duniter Web of Trust. +- **[`distance`](https://doc-duniter-org.ipns.pagu.re/pallet_distance/index.html)** Publishes median of distance computation results provided by inherents coming from `distance-oracle` workers. +- **[`identity`](https://doc-duniter-org.ipns.pagu.re/pallet_identity/index.html)** Identities are the "nodes" of Duniter's dynamic directed graph. They are one-to-one mapping to human being. +- **[`membership`](https://doc-duniter-org.ipns.pagu.re/pallet_membership/index.html)** Membership defines the state of identities. They can be member or not of the different WoTs. +- **[`universal-dividend`](https://doc-duniter-org.ipns.pagu.re/pallet_universal_dividend/index.html)** UD is at the basis of Ğ1 "libre currency". It is both a kind of "basic income" and a measure unit. ## Functional pallets -- **`duniter-test-parameters`** Test parameters only used in ĞDev to allow tweaking parameters more easily. -- **`offences`** Sorts offences that will be executed by the `authority-members` pallet. -- **`oneshot-account`** Oneshot accounts are light accounts only used once for anonimity or convenience use case. -- **`provide-randomness`** Lets blockchain users ask for a verifiable random number. -- **`session-benchmarking`** Benchmarks the session pallet. -- **`upgrade-origin`** Allows some origins to dispatch a call as root. \ No newline at end of file +- **[`duniter-test-parameters`](https://doc-duniter-org.ipns.pagu.re/pallet_duniter_test_parameters/index.html)** Test parameters only used in ĞDev to allow tweaking parameters more easily. +- **[`offences`](https://doc-duniter-org.ipns.pagu.re/pallet_offences/index.html)** Sorts offences that will be executed by the `authority-members` pallet. +- **[`oneshot-account`](https://doc-duniter-org.ipns.pagu.re/pallet_oneshot_account/index.html)** Oneshot accounts are light accounts only used once for anonymity or convenience use case. +- **[`provide-randomness`](https://doc-duniter-org.ipns.pagu.re/pallet_provide_randomness/index.html)** Lets blockchain users ask for a verifiable random number. +- **[`session-benchmarking`](https://doc-duniter-org.ipns.pagu.re/pallet_session_benchmarking/index.html)** Benchmarks the session pallet. +- **[`upgrade-origin`](https://doc-duniter-org.ipns.pagu.re/pallet_upgrade_origin/index.html)** Allows some origins to dispatch a call as root. diff --git a/runtime/README.md b/runtime/README.md index 4f74e8bea..88b4bdda5 100644 --- a/runtime/README.md +++ b/runtime/README.md @@ -2,7 +2,7 @@ Duniter client can run several runtimes. -- ĞDev is for development purpose -- ĞTest is to prepare Ğ1 migration and test features before deploying on Ǧ1 -- Ğ1 is the production currency +- [ĞDev](https://doc-duniter-org.ipns.pagu.re/gdev_runtime/index.html) is for development purpose +- [ĞTest](https://doc-duniter-org.ipns.pagu.re/gtest_runtime/index.html) is to prepare Ğ1 migration and test features before deploying on Ǧ1 +- [Ğ1](https://doc-duniter-org.ipns.pagu.re/g1_runtime/index.html) is the production currency -- GitLab