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

Capacity Pallet Documentation Improvements #1997

Merged
merged 6 commits into from
Jun 6, 2024
Merged

Capacity Pallet Documentation Improvements #1997

merged 6 commits into from
Jun 6, 2024

Conversation

wilwade
Copy link
Collaborator

@wilwade wilwade commented 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

  • Capacity Pallet Readme

Screenshot

image

@wilwade wilwade marked this pull request as draft May 31, 2024 19:30
@wilwade wilwade mentioned this pull request May 31, 2024
Open
25 tasks
@codecov Codecov
Copy link

codecov bot commented May 31, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
pallets/capacity/src/lib.rs 94.96% <100.00%> (ø)

jeanettedepatie
jeanettedepatie reviewed May 31, 2024
View reviewed changes
pallets/capacity/README.md Outdated Show resolved Hide resolved
pallets/capacity/README.md Outdated Show resolved Hide resolved
pallets/capacity/README.md Show resolved Hide resolved
pallets/capacity/README.md Outdated Show resolved Hide resolved
pallets/capacity/README.md Outdated Show resolved Hide resolved
pallets/capacity/README.md Outdated Show resolved Hide resolved
pallets/capacity/src/lib.rs Show resolved Hide resolved
@wilwade wilwade marked this pull request as ready for review June 4, 2024 20:05
@wilwade wilwade requested review from jeanettedepatie, a team, shannonwells, mattheworris, enddynayn, aramikm, claireolmstead and JoeCap08055 and removed request for a team June 4, 2024 20:05
@wilwade @claireolmstead @JoeCap08055
Apply suggestions from code review
d74595b 
Co-authored-by: V. Claire Olmstead <[email protected]>
Co-authored-by: Joe Caputo <[email protected]>
shannonwells
shannonwells approved these changes Jun 5, 2024
View reviewed changes
Copy link
Collaborator

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the current version of this, I don't have anything blocking; I think it's clear enough but if you want to wordsmith it a little more, IMO it's up to you.

JoeCap08055
JoeCap08055 approved these changes Jun 5, 2024
View reviewed changes
Copy link
Collaborator

@JoeCap08055 JoeCap08055 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some open comments, but I agree with @shannonwells--feel free to wordsmith some more, but this is a good improvement.

wilwade
wilwade commented Jun 5, 2024
View reviewed changes
pallets/capacity/README.md Outdated Show resolved Hide resolved
wilwade
wilwade commented Jun 5, 2024
View reviewed changes
pallets/capacity/README.md Outdated Show resolved Hide resolved
@wilwade wilwade merged commit c754a6f into main Jun 6, 2024
28 checks passed
@wilwade wilwade deleted the docs/capacity branch June 6, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@claireolmstead claireolmstead claireolmstead left review comments

@shannonwells shannonwells shannonwells approved these changes

@JoeCap08055 JoeCap08055 JoeCap08055 approved these changes

@jeanettedepatie jeanettedepatie Awaiting requested review from jeanettedepatie

@mattheworris mattheworris Awaiting requested review from mattheworris mattheworris was automatically assigned from frequency-chain/pr-reviewers

@enddynayn enddynayn Awaiting requested review from enddynayn enddynayn was automatically assigned from frequency-chain/pr-reviewers

@aramikm aramikm Awaiting requested review from aramikm aramikm was automatically assigned from frequency-chain/pr-reviewers

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@wilwade @shannonwells @claireolmstead @JoeCap08055 @jeanettedepatie