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 cli docs #17037

Merged
merged 11 commits into from
Feb 7, 2025
Merged

add cli docs #17037

merged 11 commits into from
Feb 7, 2025

Conversation

aaazzam
Copy link
Collaborator

@aaazzam aaazzam commented Feb 7, 2025

adds a command that reads the prefect typer app and renders it in a jinja template.

note we have some wacky docstrings in the cli, so some commands look goofy.

that said, this PR achieves the goal of adding the CLI commands to the docs (and in particular /llms-full.txt)

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i love this! bc of how simply it seems like we could iterate on it and the status quo is empty

it seems like we should probably add a pre-commit to re-render and keep us in sync

aaazzam and others added 5 commits February 6, 2025 22:57
Copy link

codspeed-hq bot commented Feb 7, 2025

CodSpeed Performance Report

Merging #17037 will not alter performance

Comparing cli-docs (33716c1) with main (b5012c4)

Summary

✅ 2 untouched benchmarks

@aaazzam
Copy link
Collaborator Author

aaazzam commented Feb 7, 2025

addressed everything @cicdw

only test failing is the sqlite flake #17036

@@ -724,6 +724,35 @@
}
],
"version": "v3"
},
{
"group": "CLI Reference",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency, we should either drop the "Reference" and "Overview" suffixes or else ensure that all top-level items use the same suffix. I think removing makes more sense.

image
Suggested change
"group": "CLI Reference",
"group": "CLI",

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My vote would be removing all the suffixes

@aaazzam aaazzam requested a review from cicdw February 7, 2025 18:31
@aaazzam aaazzam disabled auto-merge February 7, 2025 22:09
@aaazzam aaazzam merged commit 0432b6d into main Feb 7, 2025
46 checks passed
@aaazzam aaazzam deleted the cli-docs branch February 7, 2025 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants