Skip to content

Conversation

ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Jul 21, 2025

Customer is requesting for documentation to be added to the SDK site about not being able to download artifacts created with "artifact.add_reference" with checksum disabled, and suggesting that setting "checksum=true" will solve the issue. This request has been made before and has a +2 impact.

Jira ticket: https://wandb.atlassian.net/browse/DOCS-1014

Preview: https://claude-code-docs-1014.docodile.pages.dev/guides/artifacts/download-and-use-an-artifact/
Preview: https://claude-code-docs-1014.docodile.pages.dev/guides/artifacts/construct-an-artifact/#add-a-uri-reference

Status: Ready for tech review/

📄 View preview links for changed pages

@ngrayluna ngrayluna changed the title [Testing]Claude Code: Add docs on downloading reference artifacts [Testing]Claude Code: Add docs on downloading reference artifacts with checkum Jul 22, 2025
@ngrayluna ngrayluna changed the title [Testing]Claude Code: Add docs on downloading reference artifacts with checkum Artifacts: Add docs on downloading reference artifacts with checkum Jul 22, 2025
Copy link

cloudflare-workers-and-pages bot commented Aug 11, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 67c9e17
Status: ✅  Deploy successful!
Preview URL: https://f94cb896.docodile.pages.dev
Branch Preview URL: https://claude-code-docs-1014.docodile.pages.dev

View logs

@ngrayluna ngrayluna marked this pull request as ready for review August 11, 2025 19:07
@ngrayluna ngrayluna requested a review from a team as a code owner August 11, 2025 19:07
Copy link
Contributor

github-actions bot commented Aug 19, 2025

PR Preview: Changed content

Base preview: https://claude-code-docs-1014.docodile.pages.dev

Modified

Title Path
Create an artifact content/en/guides/core/artifacts/construct-an-artifact.md
Download and use artifacts content/en/guides/core/artifacts/download-and-use-an-artifact.md

@ngrayluna ngrayluna requested a review from mdlinville August 19, 2025 20:28
Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

LGTM, with a non-blocking suggested edit to align the text in the notes and a followup question.

{{% /alert %}}

{{% alert color="warning" %}}
Artifacts created with reference URIs using `checksum=False` cannot be downloaded. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Artifacts created with reference URIs using `checksum=False` cannot be downloaded. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references:
If you set `checksum=False` when adding a reference, the artifact cannot be downloaded later. Only use `checksum=False` when you need to track reference URIs without downloading capability. For downloadable artifacts, always use `checksum=True` (the default):

This way the notes at least share most of the text. But if checksum=True is the default, then line 22 seems not to need the checksum=True and it might be more clear to leave it off.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants