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

[plugin-architecture] Docs cleanup #2785

Open
victorgcramos opened this issue Jun 14, 2022 · 4 comments
Open

[plugin-architecture] Docs cleanup #2785

victorgcramos opened this issue Jun 14, 2022 · 4 comments
Labels

Comments

@victorgcramos
Copy link
Member

Currently we have lots of documented utilities and methods that are unnecessary, since they are self-descriptive.

We should avoid using our readme files for docs like that, because we may forget to update the docs, and hence create multiples sources of truth.

@victorgcramos victorgcramos self-assigned this Jun 14, 2022
@victorgcramos
Copy link
Member Author

Waiting for #2775

@victorgcramos victorgcramos removed their assignment Jul 20, 2022
@victorgcramos
Copy link
Member Author

We should add the docs about how to create apps/plugins and manipulate the politeiagui-scripts toolbox. (ref: #2827)

@victorgcramos
Copy link
Member Author

Add docs or some user guideline describing the RFP process:

  • What is an RFP proposal?
  • What is an RFP submission?
  • What is a Runoff Vote?
  • How does the RFP process work?
  • How to submit proposals to an RFP proposal?
  • How to approve an RFP submission?
    ...

Or something like that.

@victorgcramos
Copy link
Member Author

Add docs and guidelines for our core toolkit (#2869).

  • What is a "slice service"?
  • Why should I use the toolkit?
  • How can I create a service?
  • How to use services on apps?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant