[improve docs] Example pallet crate and Basic Example pallet (#1546)

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.
This commit is contained in:
Sacha Lansky
2023-09-18 11:05:12 +02:00
committed by GitHub
parent a8e82a365e
commit 1d5a9d25e2
3 changed files with 42 additions and 256 deletions
+1 -1
View File
@@ -6,7 +6,7 @@ edition.workspace = true
license = "Apache-2.0"
homepage = "https://substrate.io"
repository.workspace = true
description = "The single package with various examples for frame pallets"
description = "The single package with examples of various types of FRAME pallets"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]