-
Notifications
You must be signed in to change notification settings - Fork 52
Update README with improved documentation and examples #1097
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
base: develop
Are you sure you want to change the base?
Conversation
I see a check failed - I'm on it! 🫡 |
I see a check failed - I'm on it! 🫡 |
I see a check failed - I'm on it! 🫡 |
✅ Fixed failing check in this commit. The issue was that the code examples in the README.md were formatted as single-line function calls, which didn't match the project's formatting standards. I've restored the multi-line formatting while preserving all the content improvements. |
I've fixed the failing check on PR #1097. The issue was that the code examples in the README.md were formatted as single-line function calls, which didn't match the project's formatting standards. I restored the multi-line formatting for the function calls while preserving all the content improvements from the PR. The changes have been pushed to the PR branch and should pass the checks now. You can view the fix here: b024406 💻 View my work • React 👍 or 👎 |
…ace forEach with map, fix useExhaustiveDependencies
I've fixed the failing checks by addressing the following issues:
These changes should resolve the pre-commit hook failures. The checks are currently running. |
✅ Fixed failing pre-commit check in this commit. The issues were:
Note: The "Tests" workflow is still failing, but that's due to a permission check for the bot user, which is unrelated to our code changes. |
I've fixed the failing pre-commit check in PR #1097. The issues were:
The pre-commit check is now passing. The "Tests" workflow is still failing, but that's due to a permission check for the bot user, which is unrelated to our code changes. You can see the details in my comment on the PR. 💻 View my work • React 👍 or 👎 |
I've analyzed the failing check suite on PR #1097. The issue is not with the code itself, but with permissions. The access-check step is failing because the codegen-sh[bot] user doesn't have the required write permissions. The error message from the workflow log is:
The pre-commit checks are passing, which indicates that the code changes themselves are valid. The formatting issue with the README.md (single-line vs multi-line function calls) was already fixed in commit b024406. This is an administrative issue that needs to be addressed by granting the bot user the appropriate permissions or modifying the workflow to accommodate the bot's current permission level. Since this is a permissions issue rather than a code issue, and the pre-commit checks are passing, the PR should be ready for review despite the failing "Tests" workflow. 💻 View my work • React 👍 or 👎 |
This PR updates the README with the following improvements:
These changes make the README more comprehensive and informative for new users, providing a better overview of the SDK's capabilities and how to use it effectively.
💻 View my work • About Codegen