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

Auto Generate Architect Documentation #871

Merged
merged 6 commits into from
Aug 1, 2022
Merged

Conversation

Etesam913
Copy link
Contributor

@Etesam913 Etesam913 commented Jul 29, 2022

Overview

Uses the method from #870 to add auto-generate Architect docs.

Image:

architects

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 29, 2022
@Etesam913 Etesam913 changed the title Auto Generate Architect [WIP]Auto Generate Architect Jul 29, 2022
@Etesam913 Etesam913 changed the title [WIP]Auto Generate Architect [WIP]Auto Generate Architect Docs Jul 29, 2022
@Etesam913 Etesam913 changed the title [WIP]Auto Generate Architect Docs [WIP]Auto Generate Architect Documentation Jul 29, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jul 29, 2022

Codecov Report

Merging #871 (a58678e) into auto-generate-blueprint (c97c7a3) will increase coverage by 0.11%.
The diff coverage is n/a.

@@                     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     
Impacted Files Coverage Δ
...tractions/architects/channels/websocket_channel.py 76.56% <0.00%> (+8.59%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c97c7a3...a58678e. Read the comment docs.

@Etesam913 Etesam913 changed the title [WIP]Auto Generate Architect Documentation Auto Generate Architect Documentation Jul 31, 2022
@@ -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.")
Copy link
Contributor

@pringshia pringshia Aug 1, 2022

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?

Copy link
Contributor Author

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

Copy link
Contributor

@JackUrb JackUrb left a 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.

@Etesam913 Etesam913 changed the base branch from auto-generate-blueprint to main August 1, 2022 17:43
@Etesam913 Etesam913 merged commit fcca7a8 into main Aug 1, 2022
@Etesam913 Etesam913 deleted the auto-generate-architect branch August 8, 2022 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants