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

Add documentation explaining differences between consumer and democ consumer #680

Closed
shaspitz opened this issue Jan 24, 2023 · 1 comment
Labels
more-info-needed Further information is requested S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability scope: docs Improvements or additions to documentation

Comments

@shaspitz
Copy link
Contributor

Problem

There is not much written documentation (or code comments) explaining the difference between a consumer and democracy consumer. We should answer the following questions:

  • Why does the democracy consumer app have a staking keeper? AFAIK for a normal consumer, the consumer CCV keeper acts as the staking keeper
  • Why do we maintain apps for both a normal consumer and democracy consumer? This is not intuitive from reading code

Closing criteria

Add a markdown explaining the relevant differences in implementation and functional behavior. Sufficient code comments could also suffice.

@shaspitz shaspitz added scope: docs Improvements or additions to documentation question labels Jan 24, 2023
@mpoke mpoke added this to Cosmos Hub Jan 25, 2023
@github-project-automation github-project-automation bot moved this to 🩹 Triage in Cosmos Hub Jan 25, 2023
@mpoke mpoke added this to the ICS docs milestone Jan 27, 2023
@mpoke mpoke removed this from the ICS docs milestone Mar 5, 2023
@mpoke mpoke moved this from 🩹 Triage to 📥 Todo in Cosmos Hub Mar 5, 2023
@mpoke mpoke added this to the Create ICS docs milestone Mar 5, 2023
@shaspitz shaspitz mentioned this issue Mar 7, 2023
17 tasks
@mpoke mpoke removed this from the Create ICS docs milestone Jun 20, 2023
@mpoke mpoke added the S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability label Sep 13, 2023
@mpoke mpoke added more-info-needed Further information is requested and removed question labels Mar 22, 2024
@mpoke
Copy link
Contributor

mpoke commented Sep 17, 2024

Closing as the current docs are covering the democracy modules.

@mpoke mpoke closed this as completed Sep 17, 2024
@github-project-automation github-project-automation bot moved this from 📥 F2: Todo to 👍 F4: Assessment in Cosmos Hub Sep 17, 2024
@mpoke mpoke moved this from 👍 F4: Assessment to ✅ Done in Cosmos Hub Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
more-info-needed Further information is requested S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability scope: docs Improvements or additions to documentation
Projects
Status: ✅ Done
Development

No branches or pull requests

2 participants