Skip to content

docs: ship the data marketplace example - #3626

Open
reemsabawi-mystenlabs wants to merge 1 commit into
mainfrom
reemsabawi/bedu-1039-data-marketplace
Open

docs: ship the data marketplace example#3626
reemsabawi-mystenlabs wants to merge 1 commit into
mainfrom
reemsabawi/bedu-1039-data-marketplace

Conversation

@reemsabawi-mystenlabs

@reemsabawi-mystenlabs reemsabawi-mystenlabs commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Split 1 of 4 from #3617, which review asked to break into smaller PRs. This one is separated deliberately because it carries the only real risk in that set.

Generated by Claude Code.

Description

examples/data-marketplace was a draft: true stub and unreachable from the sidebar. This ships it as a full worked example and adds it to the Examples sidebar: storing a dataset through a publisher, a Move Listing escrow module, Seal-based gating for paid content, blob attributes for product metadata, buyer delivery, and lifetime management.

Reviewer notes

Two things to weigh, both unchanged from the original PR:

  • The page was hidden and is now published. If it should stay hidden, drop the sidebars.js entry and restore draft: true.
  • The Move Listing module is new example code and has not been compiled against the package. It uses only verified APIs (Blob has key, store, share_object, public_transfer, shared-object deletion) and Move 2024 idioms, but it is written for the docs rather than lifted from a compiling source.

Sources

Content Source
Publisher store parameters (epochs, permanent, send_object_to) Existing HTTP API docs in this repository
Blob object abilities (key, store) and management functions contracts/walrus/sources/system/blob.move
Blob attribute CLI (walrus set-blob-attribute) and Move metadata functions walrus::blob module and the existing CLI reference
Seal threshold encryption and onchain access control Seal documentation
Quilt batching for small files Existing system-overview/quilt page

The Move Listing module and the marketplace prose were written fresh for this page; no existing source to import.

Test plan

  • editorconfig-checker clean; mechanical and voice style gates passed on push.
  • All internal links and anchors verified to resolve.

Release notes

  • Storage node:
  • Aggregator:
  • Publisher:
  • CLI:

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WoBWxqLzd9hAxrhoqv3iSv
@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://MystenLabs.github.io/walrus/pr-preview/pr-3626/

Built to branch gh-pages at 2026-08-11 14:20 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions

Copy link
Copy Markdown
Contributor

📋 afdocs check results

URL: https://MystenLabs.github.io/walrus/pr-preview/pr-3626/

Running checks on mystenlabs.github.io/walrus/pr-preview/pr-3626/...

Agent-Friendly Docs Check: https://MystenLabs.github.io/walrus/pr-preview/pr-3626/
Timestamp: 8/11/2026, 2:22:06 PM

content-discoverability
  ✗ llms-txt-exists: No llms.txt found at any candidate location (https://MystenLabs.github.io/walrus/pr-preview/pr-3626/llms.txt, https://mystenlabs.github.io/llms.txt, https://mystenlabs.github.io/docs/llms.txt)
      Learn more: https://agentdocsspec.com/spec/#llms-txt-exists
  ○ llms-txt-valid: Skipped: dependency check did not pass
  ○ llms-txt-size: Skipped: dependency check did not pass
  ○ llms-txt-links-resolve: Skipped: dependency check did not pass
  ○ llms-txt-links-markdown: Skipped: dependency check did not pass
  ✗ llms-txt-directive-html: Could not test any pages; 1 failed to fetch
      Learn more: https://agentdocsspec.com/spec/#llms-txt-directive-html
  ✗ llms-txt-directive-md: Could not fetch markdown for any of 1 pages; 1 had no markdown version
      Learn more: https://agentdocsspec.com/spec/#llms-txt-directive-md

markdown-availability
  ✗ markdown-url-support: No pages support .md URLs (0/1 tested)
      Learn more: https://agentdocsspec.com/spec/#markdown-url-support
  ✗ content-negotiation: Server ignores Accept: text/markdown header (0/1 pages return markdown)
      Learn more: https://agentdocsspec.com/spec/#content-negotiation

page-size
  ✓ rendering-strategy: All 1 pages contain server-rendered content
  ○ page-size-markdown: Skipped: dependency check did not pass
  ✓ page-size-html: All 1 pages under 50K chars (median 21K HTML → 809 markdown (96% boilerplate))
  ⚠ content-start-position: 1 of 1 pages have content starting at 10–50% (worst 42%)
      Learn more: https://agentdocsspec.com/spec/#content-start-position

content-structure
  ✓ tabbed-content-serialization: No tabbed content detected across 1 pages
  ✓ section-header-quality: No tabbed content found; header quality check not applicable
  ○ markdown-code-fence-validity: Site does not serve markdown content; nothing to analyze

url-stability
  ✓ http-status-codes: All 1 pages return proper error codes for bad URLs
  ✓ redirect-behavior: No redirects detected across 1 pages

observability
  ○ llms-txt-coverage: Skipped: dependency check did not pass
  ○ markdown-content-parity: Skipped: dependency check did not pass
  ✓ cache-header-hygiene: All 1 endpoints have appropriate cache headers

authentication
  ✓ auth-gate-detection: All 1 pages are publicly accessible
  ○ auth-alternative-access: All docs pages are publicly accessible; no alternative access paths needed

Summary
  8 passed, 1 warnings, 5 failed, 9 skipped (23 total)

Full spec: https://agentdocsspec.com/spec/

@jessiemongeon1

Copy link
Copy Markdown
Contributor

Style Guide Audit

All 1 file(s) pass the style guide audit.

---
title: Building a Data Marketplace
draft: true
description: >-

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we have an example app to support this architecture and design? if not, we should have one before we publish this doc. Conceptually it is fine, but it would be better to have a solid code example to point to that supports this document's claims

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.

3 participants