mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-09 02:27:21 +00:00
Sacha Lansky
1d5a9d25e2
This fixes the broken links in the crate level documentation of the Examples crate. It also updates the documentation for the Basic Example pallet by removing the template for documenting a pallet (we now have [this](https://github.com/paritytech/polkadot-sdk/blob/master/docs/DOCUMENTATION_GUIDELINE.md) to refer to instead). Note: I found it unnecessary to provide a link to the doc guidelines as I don't think this would be where someone should discover them. I also want to flag some ideas that came while making these minor improvements in [this issue](https://github.com/paritytech/polkadot-sdk-docs/issues/27) (for a subsequent PR) as part of ongoing docs work.
44 lines
1.8 KiB
Rust
44 lines
1.8 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! # FRAME Pallet Examples
|
|
//!
|
|
//! This crate contains a collection of simple examples of FRAME pallets, demonstrating useful
|
|
//! features in action. It is not intended to be used in production.
|
|
//!
|
|
//! ## Pallets
|
|
//!
|
|
//! - [`pallet_example_basic`]: This pallet demonstrates concepts, APIs and structures common to
|
|
//! most FRAME runtimes.
|
|
//!
|
|
//! - [`pallet_example_offchain_worker`]: This pallet demonstrates concepts, APIs and structures
|
|
//! common to most offchain workers.
|
|
//!
|
|
//! - [`pallet_default_config_example`]: This pallet demonstrates different ways to implement the
|
|
//! `Config` trait of pallets.
|
|
//!
|
|
//! - [`pallet_dev_mode`]: This pallet demonstrates the ease of requirements for a pallet in "dev
|
|
//! mode".
|
|
//!
|
|
//! - [`pallet_example_kitchensink`]: This pallet demonstrates a catalog of all FRAME macros in use
|
|
//! and their various syntax options.
|
|
//!
|
|
//! - [`pallet_example_split`]: A simple example of a FRAME pallet demonstrating the ability to
|
|
//! split sections across multiple files.
|
|
//!
|
|
//! **Tip**: Use `cargo doc --package <pallet-name> --open` to view each pallet's documentation.
|