-
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 Architect Documentation #871
Conversation
Codecov Report
@@ Coverage Diff @@
## auto-generate-blueprint #871 +/- ##
===========================================================
+ Coverage 64.43% 64.55% +0.11%
===========================================================
Files 107 107
Lines 9291 9291
===========================================================
+ Hits 5987 5998 +11
+ Misses 3304 3293 -11
Continue to review full report at Codecov.
|
@@ -49,6 +48,7 @@ def main(): | |||
file_name="../../../../docs/web/docs/reference/blueprints.md", | |||
) | |||
blueprint_file.new_header(level=1, title="Blueprints") | |||
blueprint_file.new_paragraph("The blueprint determines the task content.") |
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.
https://mephisto.ai/docs/explanations/architecture_overview/#blueprints
The blueprint contains all of the related code required to set up a task run
Maybe opportunity to align and keep definitions consistent here?
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.
Yeah, I'll do that. I was just copying the output when you run mephisto wut
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.
Thanks for each of these in the set! This is a major win for both DevX and discoverability of this functionality within the docs.
…nto auto-generate-architect
Overview
Uses the method from #870 to add auto-generate Architect docs.
Image: