fix: resolve unresolved [frame] intra-doc links in reference_docs
Replace link reference syntax ([FRAME](frame) with [frame]: definition) with direct full paths (crate::pezkuwi_sdk::frame_runtime) to resolve rustdoc link resolution issues across module boundaries. The link definitions in //! module-level docs weren't being resolved for /// item-level doc comments, causing "unresolved link to 'frame'" errors in build-rustdoc CI job.
This commit is contained in:
@@ -54,7 +54,7 @@
|
||||
//! #### Dispatchable:
|
||||
//!
|
||||
//! Dispatchables are [function objects](https://en.wikipedia.org/wiki/Function_object) that act as
|
||||
//! the entry points in [FRAME](frame) pallets. They can be called by internal or external entities
|
||||
//! the entry points in [FRAME](crate::pezkuwi_sdk::frame_runtime) pallets. They can be called by internal or external entities
|
||||
//! to interact with the blockchain's state. They are a core aspect of the runtime logic, handling
|
||||
//! transactions and other state-changing operations.
|
||||
//!
|
||||
@@ -68,7 +68,7 @@
|
||||
//!
|
||||
//! #### Pezpallet
|
||||
//!
|
||||
//! Similar to software modules in traditional programming, [FRAME](frame) pallets in Bizinikiwi are
|
||||
//! Similar to software modules in traditional programming, [FRAME](crate::pezkuwi_sdk::frame_runtime) pallets in Bizinikiwi are
|
||||
//! modular components that encapsulate distinct functionalities or business logic. Just as
|
||||
//! libraries or modules are used to build and extend the capabilities of a software application,
|
||||
//! pallets are the foundational building blocks for constructing a blockchain's runtime with frame.
|
||||
@@ -119,4 +119,3 @@
|
||||
//!
|
||||
//! **Synonyms**: Teyrchain Validation Function
|
||||
//!
|
||||
//! [frame]: crate::pezkuwi_sdk::frame_runtime
|
||||
|
||||
@@ -19,8 +19,6 @@
|
||||
//!
|
||||
//! We call this class of documents "reference documents". Our goal should be to minimize the number
|
||||
//! of "reference" docs, as they incur maintenance burden.
|
||||
//!
|
||||
//! [`frame`]: crate::pezkuwi_sdk::frame_runtime
|
||||
|
||||
/// Learn how Bizinikiwi and FRAME use traits and associated types to make modules generic in a
|
||||
/// type-safe manner.
|
||||
@@ -95,10 +93,10 @@ pub mod cli;
|
||||
pub mod frame_runtime_upgrades_and_migrations;
|
||||
|
||||
/// Learn about the offchain workers, how they function, and how to use them, as provided by the
|
||||
/// [`frame`] APIs.
|
||||
/// [`crate::pezkuwi_sdk::frame_runtime`] APIs.
|
||||
pub mod frame_offchain_workers;
|
||||
|
||||
/// Learn about the different ways through which multiple [`frame`] pallets can be combined to work
|
||||
/// Learn about the different ways through which multiple [`crate::pezkuwi_sdk::frame_runtime`] pallets can be combined to work
|
||||
/// together.
|
||||
pub mod frame_pallet_coupling;
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
//!
|
||||
//! #### Smart Contracts in Bizinikiwi
|
||||
//! Smart Contracts are autonomous, programmable constructs deployed on the blockchain.
|
||||
//! In [FRAME](frame), Smart Contracts infrastructure is implemented by the
|
||||
//! In [FRAME](crate::pezkuwi_sdk::frame_runtime), Smart Contracts infrastructure is implemented by the
|
||||
//! [`pezpallet_contracts`] for WASM-based contracts or the
|
||||
//! [`pezpallet_evm`](https://github.com/polkadot-evm/frontier/tree/master/frame/evm) for EVM-compatible contracts. These pallets
|
||||
//! enable Smart Contract developers to build applications and systems on top of a Bizinikiwi-based
|
||||
@@ -208,4 +208,3 @@
|
||||
//! execution is crucial. Efficiently written contracts save costs and are less likely to hit gas
|
||||
//! limits, ensuring smoother execution on the blockchain.
|
||||
//!
|
||||
//! [frame]: crate::pezkuwi_sdk::frame_runtime
|
||||
|
||||
Reference in New Issue
Block a user