Skip to content

Commit 142a7bb

Browse files
davanstrienclaudejulien-c
authored
docs: note that buckets render README.md (#2475)
* docs: note that buckets render README.md Adds a short subsection under "Browsing Buckets on the Hub" documenting that README.md files render at the bucket root and inside subdirectories. Updates the repos-vs-buckets comparison table accordingly. Verified against a test bucket. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: add "Listing from the CLI" subsection header Orphaned "You can also list bucket contents from the CLI" between two H3s. Give it its own header so the section structure reads cleanly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Update docs/hub/storage-buckets.md Co-authored-by: Julien Chaumond <julien@huggingface.co> * docs: realign table column after suggestion edit The accepted suggestion lengthened the third-column cell but kept the original trailing padding, pushing the closing pipe past the column boundary. Trim trailing spaces so the column aligns again. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Julien Chaumond <julien@huggingface.co>
1 parent e7d53f5 commit 142a7bb

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

docs/hub/storage-buckets.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Hub offers two types of storage: Git-based **repositories** for versioned, c
2222
| Operations | Hub API, Git push/pull | S3-like `sync`, `cp`, `rm` |
2323
| Deduplication | Xet chunk-level | Xet chunk-level |
2424
| Pull Requests | Yes | No |
25-
| Model/Dataset Cards| Yes | No |
25+
| Model/Dataset Cards| Yes | No (but plain README rendered) |
2626

2727
Use **repositories** when you want version history, collaboration features (PRs, discussions), and library integrations. Use **buckets** when you need fast, mutable storage for data that changes frequently — files can be overwritten or deleted in place.
2828

@@ -94,6 +94,12 @@ Every bucket has a page on the Hub where you can browse its contents, navigate d
9494
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/buckets/buckets-file-browser-dark.png"/>
9595
</div>
9696

97+
### README rendering
98+
99+
If a directory in your bucket contains a `README.md` file, the Hub renders it below the file list on that directory's page. This works both at the bucket root and inside any subdirectory — useful for documenting what a bucket contains, how data is organized, or how downstream tools should consume it.
100+
101+
### Listing from the CLI
102+
97103
You can also list bucket contents from the CLI:
98104

99105
```bash

0 commit comments

Comments
 (0)