Open kianenigma opened 1 year ago
A few guidelines about writing reference docs:
docify
. See https://github.com/paritytech/polkadot-sdk/issues/991. docify
types and traits from their dependencies. For example, it should be pretty common to pull in sp-runtime
and frame-support
such that you can docify
and grab a trait form a path in these crates and show it in your docs.
Reference docs are topics that are too high level to be explained in a rust-doc, and too low level to be explained in a high level tutorial. The goal is to minimize this category.
FRAME, Substrate
Currency
,ReservableCurrency
etc.) and new ones (fungible::*
).UncheckedExtrinsic
)Box
, and being memory conscious.Misc