Generic documentation (#98)

* change runtime template, added generic-runtime documentation
This commit is contained in:
Özgün Özerk
2024-01-16 15:54:24 +03:00
committed by GitHub
parent bccaf4ef2c
commit db59c2ffb6
3 changed files with 135 additions and 6 deletions
+9 -6
View File
@@ -1,7 +1,7 @@
:source-highlighter: highlight.js
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
= Pallet Name
= Runtime Name
== Purpose
@@ -11,11 +11,13 @@ Freeform description of runtime purpose
// List of pallets with their config description
=== `++pallet_name++` link:https://google.com[{github-icon},role=heading-link]
=== Pallet Category
[%collapsible]
====
===== `++pallet_name++` link:https://google.com[{github-icon},role=heading-link]
Freeform description of the reason why this pallet was added.
```rust
Freeform description may include important configuration parameters as:
impl pallet_name::Config for Runtime {
type Config1 = Type1;
type Config2 = Type2;
@@ -24,7 +26,8 @@ impl pallet_name::Config for Runtime {
* Description of `Type1` if needed
* Description of `Type2` if needed
====
**Relations**
Description of which pallets will get affected if this pallet is going to be removed or changed
=== Important Config Changes Specific to This Template