[19] add templates and inner docs builder

This commit is contained in:
Nikita Khateev
2023-12-07 16:29:21 +04:00
parent 3c3f31a718
commit 1567442895
8 changed files with 799 additions and 39 deletions
+2 -2
View File
@@ -1,3 +1,3 @@
* General Guides
* Runtime Descriptions
* Pallet guides
** xref:pallets/pallet.adoc[pallet2]
* Pallet Specifications
@@ -1,36 +0,0 @@
:source-highlighter: highlight.js
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
= Pallet Name
== Purpose
This is a freeform description of the tasks that this pallet fulfills
== Config
* `ConfigType` -- desription of config. Include the possible values if there is a set of them.
== Dispatchables
[[add_proxy]]
=== `++dispatchable_name++` link:https://google.com[{github-icon},role=heading-link]
```rust
pub fn dispatchable_name(
param1: Type1,
param2: Type2
) -> DispatchResult
```
Freeform description of the dispatchable. It is good to include the important things that should be included there.
**Params:**
* `param1: Type1` -- description of the parameter
**Errors:**
* `ErrorName` -- description of conditions, when this error happens
**Events:**
* `EventName(param1, param2)` -- description of event, if needed (they are often self-explanatory)