Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Retreive Pallet API documentation from Frequency #59

Open
12 of 25 tasks
wilwade opened this issue May 22, 2023 · 0 comments
Open
12 of 25 tasks

Retreive Pallet API documentation from Frequency #59

wilwade opened this issue May 22, 2023 · 0 comments
Assignees
@wilwade

Comments

@wilwade
Copy link
Contributor

wilwade commented May 22, 2023 •
edited
Loading

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)

  • Pallet Errors
    • Frequency
    • Substrate
  • Pallet Extrinsics
    • Frequency
    • Substrate
  • Pallet State Queries
    • Frequency
    • Substrate
  • Runtime RPCs
    • Frequency
    • Substrate
  • Node RPCs
    • Frequency
    • Substrate

Old Ideas
@wilwade wilwade self-assigned this May 22, 2023
@wilwade wilwade mentioned this issue May 6, 2024
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue May 8, 2024
@wilwade @JoeCap08055
MSA Pallet Docs (#1962)
a3abf5b 
# 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 wilwade changed the title Investigate Generating API docs from the Rust Retreive Pallet API documentation from Frequency May 9, 2024
@wilwade wilwade mentioned this issue May 10, 2024
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue May 15, 2024
@wilwade @shannonwells
Schemas Pallet Documentation (#1968)
857169d 
# 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
@wilwade @JoeCap08055 @shannonwells
MSA Pallet Docs (#1962)
5e7e24b 
# 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
@wilwade @shannonwells
Schemas Pallet Documentation (#1968)
1699361 
# 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
Merged
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue May 23, 2024
@wilwade
Time Release Pallet Documentation Improvement (#1978)
fc1224d 
# 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 wilwade mentioned this issue May 24, 2024
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue May 29, 2024
@wilwade @JoeCap08055
Messages Pallet Documentation Improvement (#1981)
a99aab4 
# 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
Merged
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue May 31, 2024
@wilwade @JoeCap08055
Handles Pallet Documentation Improvement (#1984)
3625aed 
# 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 wilwade mentioned this issue May 31, 2024
Merged
wilwade added a commit to frequency-chain/frequency that referenced this issue Jun 3, 2024
@wilwade
Frequency Transaction Pallet Documentation Improvement (#1990)
a005613 
# 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
@wilwade @JoeCap08055 @claireolmstead
Stateful Storage Pallet Documentation Improvement (#1989)
be6a41b 
# 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
@wilwade @claireolmstead @JoeCap08055
Capacity Pallet Documentation Improvements (#1997)
c754a6f 
# 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
@wilwade @JoeCap08055
MSA Pallet Docs (#1962)
de529c8 
# 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
@wilwade @shannonwells
Schemas Pallet Documentation (#1968)
f91a6e3 
# 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
@wilwade
Time Release Pallet Documentation Improvement (#1978)
7608d42 
# 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
@wilwade @JoeCap08055
Messages Pallet Documentation Improvement (#1981)
4ef4bc2 
# 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
@wilwade @JoeCap08055
Handles Pallet Documentation Improvement (#1984)
07ffd72 
# 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
@wilwade
Frequency Transaction Pallet Documentation Improvement (#1990)
d6874a2 
# 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
@wilwade @JoeCap08055 @claireolmstead
Stateful Storage Pallet Documentation Improvement (#1989)
097e9fa 
# 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
@wilwade @claireolmstead @JoeCap08055
Capacity Pallet Documentation Improvements (#1997)
ca19da6 
# 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
Assignees

@wilwade wilwade

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wilwade