Retreive Pallet API documentation from Frequency #59
Assignees
Comments
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
May 8, 2024
# 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]>
wilwade
changed the title
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
May 15, 2024
# 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 - Schemas Pallet --------- Co-authored-by: Shannon Wells <[email protected]>
shannonwells
pushed a commit
to frequency-chain/frequency
that referenced
this issue
May 16, 2024
# 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]>
shannonwells
added a commit
to frequency-chain/frequency
that referenced
this issue
May 16, 2024
# 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 - Schemas Pallet --------- Co-authored-by: Shannon Wells <[email protected]>
This was referenced May 22, 2024
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
May 23, 2024
# 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 - Time Release Pallet (No RPCs for this pallet) - Small fixes in the template
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
May 29, 2024
# 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 - Messages Pallet Readme --------- Co-authored-by: Joe Caputo <[email protected]>
This was referenced May 29, 2024
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
May 31, 2024
# 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 - Handles Pallet Readme Co-authored-by: Joe Caputo <[email protected]>
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
Jun 3, 2024
# 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 - Frequency Tx Pallet Readme
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
Jun 3, 2024
# 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 - Stateful Storage Pallet Readme --------- Co-authored-by: Joe Caputo <[email protected]> Co-authored-by: V. Claire Olmstead <[email protected]>
wilwade
added a commit
to frequency-chain/frequency
that referenced
this issue
Jun 6, 2024
# 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 - Capacity Pallet Readme --------- Co-authored-by: V. Claire Olmstead <[email protected]> Co-authored-by: Joe Caputo <[email protected]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Schemas Pallet --------- Co-authored-by: Shannon Wells <[email protected]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Time Release Pallet (No RPCs for this pallet) - Small fixes in the template
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Messages Pallet Readme --------- Co-authored-by: Joe Caputo <[email protected]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Handles Pallet Readme Co-authored-by: Joe Caputo <[email protected]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Frequency Tx Pallet Readme
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Stateful Storage Pallet Readme --------- Co-authored-by: Joe Caputo <[email protected]> Co-authored-by: V. Claire Olmstead <[email protected]>
rustadot
pushed a commit
to rustadot/recurrency
that referenced
this issue
Sep 5, 2024
# 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 - Capacity Pallet Readme --------- Co-authored-by: V. Claire Olmstead <[email protected]> Co-authored-by: Joe Caputo <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Goal: Nice docs that are focused on developers using the chain, not docs for Rust developers
How: Custom Readmes per Frequency Pallet that are structured to also be pulled into these docs
Generalized Pieces
(Check off once added to ^ not when complete)
Old Ideas
--format-output json+ something like https://github.com/IonicaBizau/json2mdThe text was updated successfully, but these errors were encountered: