Skip to content

Adds docs for @codegen.function decorator #187

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 3 commits into from
Jan 29, 2025

Conversation

kopekC
Copy link
Member

@kopekC kopekC commented Jan 29, 2025

#Motivation

To provide clear documentation on how to use the function decorator within the codegen SDK, including examples of deploying and running functions using the CLI.
#Content

Added a new document function-decorator.mdx in the building-with-codegen directory. This document includes usage instructions, examples, and CLI commands for deploying and running functions.
#Testing

Reviewed the documentation for accuracy and clarity. Verified that the links to related documents are correct.
Please check the following before marking your PR as ready for review
[x] I have added tests for my changes
[x] I have updated the documentation or added new documentation as needed
[x] I have read and agree to the Contributor License Agreement

@kopekC kopekC requested review from codegen-team and a team as code owners January 29, 2025 21:23
@kopekC kopekC requested review from EdwardJXLi and removed request for a team January 29, 2025 21:23
@CLAassistant
Copy link

CLAassistant commented Jan 29, 2025

CLA assistant check
All committers have signed the CLA.

@kopekC kopekC merged commit eb523a0 into develop Jan 29, 2025
6 of 9 checks passed
@kopekC kopekC deleted the ed/cg-10550-explain-codegenfunction branch January 29, 2025 21:34
jayhack pushed a commit that referenced this pull request Feb 9, 2025
#Motivation
<!-- Why is this change necessary? -->
To provide clear documentation on how to use the function decorator
within the codegen SDK, including examples of deploying and running
functions using the CLI.
#Content
<!-- Please include a summary of the change -->
Added a new document function-decorator.mdx in the building-with-codegen
directory. This document includes usage instructions, examples, and CLI
commands for deploying and running functions.
#Testing

<!-- How was the change tested? -->
Reviewed the documentation for accuracy and clarity. Verified that the
links to related documents are correct.
Please check the following before marking your PR as ready for review
[x] I have added tests for my changes
[x] I have updated the documentation or added new documentation as
needed
[x] I have read and agree to the Contributor License Agreement
---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants