-
Notifications
You must be signed in to change notification settings - Fork 77
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
Auto Generate Provider Documentation #873
Conversation
Codecov Report
@@ Coverage Diff @@
## auto-generate-requester #873 +/- ##
===========================================================
+ Coverage 64.48% 64.55% +0.07%
===========================================================
Files 107 107
Lines 9289 9291 +2
===========================================================
+ Hits 5990 5998 +8
+ Misses 3299 3293 -6
Continue to review full report at Codecov.
|
) | ||
provider_file.new_header(level=1, title="Provider") | ||
provider_file.new_paragraph( | ||
"The crowd provider determines the source of the crowd workers." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the simplicity of what you have here. I think I would merge it with some of the details from https://mephisto.ai/docs/explanations/architecture_overview/#crowdproviders to say something like:
Crowd providers standardize access to external crowd workers, by wrapping external API communication through a standardized interface.
cc @JackUrb
provider_file = MdUtils( | ||
file_name="../../../../docs/web/docs/reference/providers.md", | ||
) | ||
provider_file.new_header(level=1, title="Provider") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the other sibling pages are plural ("Architects", "Blueprints"). Can we call this "Providers" to stay consistent?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Simple enough! Provider
's at the moment don't have very much to customize on a launch, but I'm happy to have this for the ones that inevitably get more complex (very future-proofed!)
Overview
Uses the method from #870 to add auto-generate Provider docs.
Image