From 4cdd8ce35c6e0e173ffb36bdd912c41d46919b89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=96zg=C3=BCn=20=C3=96zerk?= Date: Mon, 8 Jan 2024 12:35:14 +0300 Subject: [PATCH] fix namings and links (#91) * fix namings and links --- docs/modules/ROOT/nav.adoc | 15 ++++++++------- docs/modules/ROOT/pages/pallets/aura_ext.adoc | 10 +++++----- .../ROOT/pages/pallets/transaction_payment.adoc | 2 +- .../pages/pallets/{pallet_xcm.adoc => xcm.adoc} | 0 4 files changed, 14 insertions(+), 13 deletions(-) rename docs/modules/ROOT/pages/pallets/{pallet_xcm.adoc => xcm.adoc} (100%) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 0890412..925a117 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -3,15 +3,16 @@ * Runtime Descriptions ** xref:runtime/xcm_executor.adoc[XCM Executor] * Pallet Specifications -** xref:pallets/transaction_payment.adoc[pallet_transaction_payment] -** xref:pallets/pallet_xcm.adoc[pallet_xcm] -** xref:pallets/proxy.adoc[pallet_proxy] -** xref:pallets/multisig.adoc[pallet_multisig] -** xref:pallets/message-queue.adoc[pallet_message_queue] ** xref:pallets/aura_ext.adoc[cumulus_aura_ext] ** xref:pallets/collator-selection.adoc[collator_selection] -** xref:pallets/parachain-system.adoc[parachain_system] -** xref:pallets/balances.adoc[pallet_balances] +** xref:pallets/aura_ext.adoc[cumulus_pallet_aura_ext] +** xref:pallets/parachain-system.adoc[cumulus_pallet_parachain_system] ** xref:pallets/xcmp-queue.adoc[cumulus_pallet_xcmp_queue] +** xref:pallets/balances.adoc[pallet_balances] +** xref:pallets/message-queue.adoc[pallet_message_queue] +** xref:pallets/multisig.adoc[pallet_multisig] +** xref:pallets/proxy.adoc[pallet_proxy] +** xref:pallets/transaction_payment.adoc[pallet_transaction_payment] +** xref:pallets/xcm.adoc[pallet_xcm] * Appendix ** xref:glossary.adoc[Glossary] diff --git a/docs/modules/ROOT/pages/pallets/aura_ext.adoc b/docs/modules/ROOT/pages/pallets/aura_ext.adoc index d59eae6..f7e5ac5 100644 --- a/docs/modules/ROOT/pages/pallets/aura_ext.adoc +++ b/docs/modules/ROOT/pages/pallets/aura_ext.adoc @@ -2,7 +2,7 @@ :highlightjs-languages: rust :github-icon: pass:[] -= cumulus_aura_ext += cumulus_pallet_aura_ext Branch/Release: `release-polkadot-v1.3.0` @@ -18,9 +18,9 @@ This pallet integrates parachain’s own block production mechanism (for example There is no special config for this integration and it has no dispatchables, but you need to integrate it with other `parachain-system` crate: === Integrate `BlockExecutor` - + When you invoke the `register_validate_block` macro, you should provide `cumulus_pallet_aura_ext::BlockExecutor` to it to allow `aura-ext` to validate the blocks produced by `aura` - + [source, rust] ---- cumulus_pallet_parachain_system::register_validate_block! { @@ -28,9 +28,9 @@ cumulus_pallet_parachain_system::register_validate_block! { BlockExecutor = cumulus_pallet_aura_ext::BlockExecutor::, } ---- - + === Integrate `ConsensusHook` - + Also you might want to manage the consensus externally and control the segment that is not yet included (its capacity, speed and etc.) `aura-ext` provides the `FixedVelocityConsensusHook` that allows to check if we are still in the limits for the slot. [source, rust] diff --git a/docs/modules/ROOT/pages/pallets/transaction_payment.adoc b/docs/modules/ROOT/pages/pallets/transaction_payment.adoc index 4024d29..6d479db 100644 --- a/docs/modules/ROOT/pages/pallets/transaction_payment.adoc +++ b/docs/modules/ROOT/pages/pallets/transaction_payment.adoc @@ -2,7 +2,7 @@ :highlightjs-languages: rust :github-icon: pass:[] -= pallet_transaction_payment += cumulus_pallet_parachain_system Branch/Release: `release-polkadot-v1.3.0` diff --git a/docs/modules/ROOT/pages/pallets/pallet_xcm.adoc b/docs/modules/ROOT/pages/pallets/xcm.adoc similarity index 100% rename from docs/modules/ROOT/pages/pallets/pallet_xcm.adoc rename to docs/modules/ROOT/pages/pallets/xcm.adoc