Skip to content

Conversation

@designcode
Copy link
Contributor

@designcode designcode commented Nov 28, 2025


Summary by Gitar

  • API simplification:
    • Replaced verbose multipart upload implementation with handleClientUpload helper in examples.mdx
    • Removed ~110 lines of boilerplate code handling upload actions, validation, and error handling
  • API parameter rename:
    • Updated client-side upload functions to use name parameter instead of path in client-uploads.mdx
  • New list filtering options:
    • Added delimiter and prefix parameters to list() function documentation in using-sdk.mdx

@vercel
Copy link

vercel bot commented Nov 28, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-redirect Ready Ready Preview Comment Nov 28, 2025 2:45pm
tigris-os-docs Ready Ready Preview Comment Nov 28, 2025 2:45pm

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 28, 2025

Greptile Overview

Greptile Summary

Updated SDK documentation to use name parameter instead of path for upload operations, and added delimiter and prefix parameters to the list options documentation.

  • Changed parameter name from path to name in client upload documentation
  • Updated multipart upload example to use name parameter consistently
  • Added missing delimiter and prefix parameters to list options table
  • Issue found: Simple upload example in examples.mdx still uses path instead of name (lines 277-278)

Confidence Score: 3/5

  • This PR is safe to merge after fixing the inconsistency in the simple upload example
  • Documentation changes are mostly consistent, but there's an incomplete refactoring in the simple upload example that will confuse users if not fixed
  • Pay close attention to docs/sdks/tigris/examples.mdx - the simple upload section needs to be updated to match the multipart upload changes

Important Files Changed

File Analysis

Filename Score Overview
docs/sdks/tigris/client-uploads.mdx 5/5 Updated parameter name from path to name in upload function documentation - changes are consistent
docs/sdks/tigris/examples.mdx 3/5 Updated multipart upload example to use name instead of path, but missed the simple upload section which still uses path
docs/sdks/tigris/using-sdk.mdx 5/5 Added delimiter and prefix parameters to list options table - documentation improvement

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Additional Comments (2)

  1. docs/sdks/tigris/examples.mdx, line 277 (link)

    syntax: inconsistent with multipart upload example above - should use name instead of path

  2. docs/sdks/tigris/examples.mdx, line 278 (link)

    syntax: inconsistent with multipart upload example above - should use name instead of path

3 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

MantasMiksys
MantasMiksys previously approved these changes Nov 28, 2025
@gitar-bot
Copy link

gitar-bot bot commented Nov 28, 2025

Gitar Rules 🎸 1 action taken

Gitar Rules

🎸 PR Summary Enhancement: PR description contains comprehensive summary with API simplification details
Flaky Test Retry: All CI checks passing - no test failures detected
  • Auto-apply suggestions - Allow Gitar to commit updates to this branch

Was this helpful? React with 👍 / 👎 | This comment will update automatically (Docs)

@designcode designcode merged commit 79fe3cb into main Nov 28, 2025
10 checks passed
@designcode designcode deleted the fix/update-sdk-docs branch November 28, 2025 18:43
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.

5 participants