Skip to content

fix: Update docs for codegen create command to include required PATH parameter #963

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

Merged
merged 1 commit into from
Mar 25, 2025

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Mar 25, 2025

Recommended by @enismaxim1

This PR updates the documentation for the codegen create command to correctly include the required PATH parameter.

Changes

  • Updated examples in various documentation files to show the correct usage: codegen create my-function . -d "describe what you want to do"
  • Added explanations about the PATH parameter being required
  • Updated command usage syntax in the create.mdx file
  • Fixed examples in init.mdx, dot-codegen.mdx, reusable-codemods.mdx, and work-with-ai.mdx

This addresses the issue reported in Slack where the instructions after running codegen init were incorrect, as they didn't include the required PATH parameter.

Fixes the issue where users were seeing errors when following the documentation without specifying a path.

@jayhack jayhack changed the title Update documentation for codegen create command to include required PATH parameter fix: Update docs for codegen create command to include required PATH parameter Mar 25, 2025
@jayhack jayhack marked this pull request as ready for review March 25, 2025 17:51
@jayhack jayhack requested review from codegen-team and a team as code owners March 25, 2025 17:51
@jayhack jayhack merged commit b4e906c into develop Mar 25, 2025
16 of 18 checks passed
@jayhack jayhack deleted the gen/db07fd28-0b27-47d7-8bec-cf5752ebc067 branch March 25, 2025 17:55
Copy link
Contributor

🎉 This PR is included in version 0.52.24 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

1 participant