docs: add callouts and examples for keygen in other languages

juliusmarminge commented 1 month ago

TODO

[x] deploy the /v7/prepareUpload endpoint https://github.com/pingdotgg/uploadthing-infra/pull/584
[x] test the PHP and Go snippets and make sure they are equal to JS impl.
[ ] idk what other langs to include 😅 ruby?

Summary by CodeRabbit

Documentation
- Enhanced documentation for file uploads, including a new section on generating valid file keys using JavaScript SDK with examples in Python, PHP, and Go.
- Added a note regarding potential latency when requesting file keys from the /v7/prepareUpload REST endpoint.
- Improved document structure with tabs for different programming languages for easier navigation.
- Clarified the server-side upload process and reinforced the importance of correct parameter handling.
Bug Fixes
- Updated function signature for generateKey to improve clarity in the documentation.
Chores
- Expanded syntax highlighting capabilities to include Go and PHP in code snippets.

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: b7bfe56432fc919da7f6057bb296c4236718f86c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 7:27pm

1 Skipped Deployment

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@juliusmarminge has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

📥 Commits
Files that changed from the base of the PR and between 8a3632c1ce0baddd0b801c09b7afbe8fd88a9ce8 and b7bfe56432fc919da7f6057bb296c4236718f86c.

Walkthrough

The changes primarily enhance the documentation for file uploads to UploadThing. A new section detailing the generation of valid file keys has been added, including code snippets in multiple programming languages. The documentation structure has been improved with tabs for easier navigation. Additionally, updates were made to the generateKey function syntax, and modifications were introduced to the rehypeShiki function to support syntax highlighting for Go and PHP. Overall, these changes aim to improve clarity and usability for developers.

Changes

File Path	Change Summary
docs/src/app/(docs)/uploading-files/page.mdx	Added a new section on generating valid file keys with code snippets in JavaScript, Python, PHP, and Go; modified `generateKey` function from arrow to standard function; clarified server-side upload process and added caution about parameter matching.
docs/src/mdx/rehype.js	Updated `rehypeShiki` function to include "go" and "php" in the syntax highlighting capabilities.

Possibly related PRs

#988: Modifies documentation related to UploadThing, including changes to the uploadRouter and file uploading functionality.

Suggested labels

examples

Poem

In the land of code where rabbits play,
New keys for uploads brighten the way.
With snippets in paws, we hop and we cheer,
For clearer docs bring us all near!
So let’s share our wisdom, both far and wide,
In the world of UploadThing, let’s take pride! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 1 month ago

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	27.50KB	See Treemap 📊
PR (20bf7960a5dc69a14c7871ce5fefcdcf49216f57)	27.50KB	See Treemap 📊
Diff	No change

markflorkowski commented 4 weeks ago

idk what other langs to include 😅 ruby?

I think ruby and Java are probably the two other big ones. I have had a surprising number of people ask about dotnet too, but I don't think there is really demand there

juliusmarminge commented 4 weeks ago

and Java

god do i have to install java on my system...

pingdotgg / uploadthing