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.

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

docs: add note about credit type to credit class tutorial #2026

Merged
merged 4 commits into from
Aug 28, 2023

Conversation

wgwz
Copy link
Contributor

@wgwz wgwz commented Aug 22, 2023

Description

Adds a note to the credit class management tutorial about the credit type that's likely to be used when following the tutorial.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the documentation writing guidelines
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct docs: prefix in the PR title
  • confirmed all author checklist items have been addressed
  • confirmed that this PR only changes documentation
  • reviewed content for consistency
  • reviewed content for thoroughness
  • reviewed content for spelling and grammar
  • tested instructions (if applicable)

@wgwz wgwz requested a review from ryanchristo August 22, 2023 13:50
Comment on lines 352 to 353
The `credit-type-abbrev` must be one of the allowed credit types for your chain.
By default, the only allowed credit type is `C`, so unless you've manually configured other credit types in your chains genesis file, you will need to use `C` here.
Copy link
Member

@ryanchristo ryanchristo Aug 22, 2023

Choose a reason for hiding this comment

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

I think we should add to the allowlist and class fee section rather than instructing users to use C. There are several credit types on redwood and soon to be more on mainnet. We can link to the docs and demonstrate how to look up the credit types as we do for the allowlist and class fee.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense, if you share some of the references I'd be glad to give it a go modifying the tutorial as you suggest. Won't be able to do that until next week, but happy to do it. I'm just in need of some references/further info to better understand what you'd like to do. But if you'd just prefer to do it, I'm fine with that too

@ryanchristo ryanchristo added the backport/v5.1.x backport to release/v5.1.x branch label Aug 28, 2023
@ryanchristo
Copy link
Member

@wgwz can you review the changes I just pushed? I think this is a bit more flexible and takes into account other credit types.

@wgwz
Copy link
Contributor Author

wgwz commented Aug 28, 2023

@wgwz can you review the changes I just pushed? I think this is a bit more flexible and takes into account other credit types.

LGTM! Perhaps we could add some info about how to add new credit types, but I'm ok with considering that out of scope for this tutorial, if that's what you're thinking.

@ryanchristo
Copy link
Member

LGTM! Perhaps we could add some info about how to add new credit types, but I'm ok with considering that out of scope for this tutorial, if that's what you're thinking.

We added instructions for submitting a governance proposal to add a credit type in the message-based governance proposal tutorial: https://docs.regen.network/tutorials/user/message-based-governance-proposals.html#add-credit-type.

I think this is out of scope for this tutorial but maybe we could link to the tutorial. I can add a note.

@wgwz
Copy link
Contributor Author

wgwz commented Aug 28, 2023

We added instructions for submitting a governance proposal to add a credit type in the message-based governance proposal tutorial: https://docs.regen.network/tutorials/user/message-based-governance-proposals.html#add-credit-type.

I think this is out of scope for this tutorial but maybe we could link to the tutorial. I can add a note.

Nice, I think a note to that tutorial would be great

@ryanchristo
Copy link
Member

Nice, I think a note to that tutorial would be great

Note added with link to proposal tutorial. 👍

@ryanchristo ryanchristo merged commit b16e8d6 into regen-network:main Aug 28, 2023
mergify bot pushed a commit that referenced this pull request Aug 28, 2023
Co-authored-by: ryanchristo <12519942+ryanchristo@users.noreply.github.com>
(cherry picked from commit b16e8d6)
ryanchristo pushed a commit that referenced this pull request Aug 28, 2023
…2026) (#2028)

Co-authored-by: Kyle Lawlor-Bagcal <wgwz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v5.1.x backport to release/v5.1.x branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants