MSA Pallet Docs #1962
MSA Pallet Docs #1962
Conversation
wilwade
requested review from
p5150j,
shannonwells,
mattheworris,
enddynayn,
aramikm,
claireolmstead,
saraswatpuneet,
JoeCap08055 and
jeanettedepatie
| @@ -197,7 +197,7 @@ benchmarks-capacity: | |||
|
|
|||
| .PHONY: docs | |||
| docs: | |||
| RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --features frequency | |||
| RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --features frequency | |||
There was a problem hiding this comment.
Needed for some versions of rust, but fine on all as far as I can tell
There was a problem hiding this comment.
Try reviewing in "Rich diff"
| @@ -1,35 +1,13 @@ | |||
| //! # MSA Pallet | |||
| //! The MSA pallet provides functionality for handling Message Source Accounts. | |||
| //! Message Source Account Management | |||
There was a problem hiding this comment.
This is here as it is what is picked up by rust docs to show as the short description in the docs search
| @@ -0,0 +1,16 @@ | |||
| #!/bin/sh | |||
|
|
|||
| # Quick script to output the runtime spec_version at a particular commit. | |||
There was a problem hiding this comment.
Helpful for getting the spec_version in the past. I can drop this file if people think it isn't worth it.
Codecov ReportAll modified and coverable lines are covered by tests ✅
|
Co-authored-by: Joe Caputo <[email protected]>
|
In my view, the Extrinsics table is cut off on the bottom. |
pallets/msa/README.md
Outdated
|
|
||
| | Name/Description | Caller | Payment | Key Events | Runtime Added | | ||
| | --------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | | ||
| | `add_public_key_to_msa`<br />Add MSA control key | Delegator or Provider with Signature | Free | [`PublicKeyAdded`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.PublicKeyAdded) | 1 | |
There was a problem hiding this comment.
nit: Depending on the audience, is Free ambiguous? e.g. Free for end users, who are using Capacity. Not sure if this is a good spot to make the distinction.
There was a problem hiding this comment.
Actually this line is wrong! This one is supposed to be Capacity which is separate from Free. The Caller column was supposed to help disambiguate Capacity and free.
There was a problem hiding this comment.
Fixed! Does it work better now?
# Goal The goal of this PR is to improve the documentation of the Pallets and make that documentation be able to be used on `docs.frequency.xyz`. Part of frequency-chain/docs#59 # Discussion - This is the first one, so it includes the needed documentation and templates as well. - Please suggest additional content that would be useful as well - Had a hard time getting it to look nice in both markdown and the rendered html. - Disabling soft wrap will help it look better - The idea was to keep rust specific things out of the readme and in the `lib.rs` # Testing - `make docs` - `open target/doc/pallet_msa/index.html` Co-authored-by: Joe Caputo <[email protected]>
Goal
The goal of this PR is to improve the documentation of the Pallets and make that documentation be able to be used on
docs.frequency.xyz.Part of frequency-chain/docs#59
Discussion
lib.rsTesting
make docsopen target/doc/pallet_msa/index.htmlScreenshots