docs: remove tigrisheaders package documentation from README #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove mentions of the tigrisheaders package to focus on the main storage package API. Assisted-by: GLM 4.7 via Claude Code Signed-off-by: Xe Iaso <xe@tigrisdata.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes documentation for the tigrisheaders package from the README to focus on the main storage package. The tigrisheaders package itself remains in the codebase and is still used internally by the SDK.
Changes:
- Simplified the Overview section to describe only the
storagepackage - Removed the entire "Using the tigrisheaders Package" section with examples for static replication, query metadata, conditional operations, snapshots, and custom headers
Comments suppressed due to low confidence (1)
README.md:138
- The Documentation section still links to Query Metadata, Conditional Operations, and Regions documentation pages. However, these features are only accessible via the
tigrisheaderspackage, which is no longer documented in this README. Consider either removing these links or adding a note explaining that these features are available through the lower-leveltigrisheaderspackage (without providing full documentation).
- [Query Metadata](https://www.tigrisdata.com/docs/objects/query-metadata/)
- [Conditional Operations](https://www.tigrisdata.com/docs/objects/conditionals/)
- [Regions](https://www.tigrisdata.com/docs/concepts/regions/)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **`storage`** - The main package containing the Tigris client with S3-compatible methods plus Tigris-specific features like bucket forking, snapshots, and object renaming. | ||
| - **`tigrisheaders`** - Lower-level helpers for setting Tigris-specific HTTP headers on S3 API calls. | ||
| This SDK provides the main **`storage`** package containing the Tigris client with S3-compatible methods plus Tigris-specific features like bucket forking, snapshots, and object renaming. |
There was a problem hiding this comment.
The Overview mentions "Tigris-specific features like bucket forking, snapshots, and object renaming" but some Tigris-specific features documented in the removed section (query metadata, conditional operations, static replication regions) are not mentioned here. Consider clarifying whether this is the complete list of features exposed via the main storage package, or if additional features exist in other packages.
Suggested change
| This SDK provides the main **`storage`** package containing the Tigris client with S3-compatible methods plus Tigris-specific features like bucket forking, snapshots, and object renaming. | |
| This SDK provides the main **`storage`** package containing the Tigris client with S3-compatible methods plus Tigris-specific features such as bucket forking, snapshots, and object renaming, as well as additional capabilities (for example, queryable metadata, conditional operations, and static replication-region controls). Some of these advanced features are exposed via supporting packages in this repository. |
Collaborator
Author
|
@ovaistariq Could you please review this PR when you have a chance? Thanks! |
ovaistariq
approved these changes
Jan 15, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
tigrisheaderspackage from README.mdstoragepackageDetails
The README previously documented both the
storageandtigrisheaderspackages. This PR removes alltigrisheadersdocumentation to focus the README on the primary public API.Test plan
go build ./...npm run format