Skip to content

Conversation

@MattPoblete
Copy link

Updated documentation section with a badge link to auto update documentation on deepwiki.

Description

Add a badge to auto update the documentation on deepwiki

Test plan

Visit https://deepwiki.com/Crossmint/crossmint-sdk to verify the date of the most recent update.
image

Package updates

README.md

Updated documentation section with a badge link to auto update documentation on deepwiki.
Copilot AI review requested due to automatic review settings December 3, 2025 05:43
@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2025

⚠️ No Changeset found

Latest commit: e605a60

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Dec 3, 2025

@MattPoblete is attempting to deploy a commit to the Crossmint-Devrel Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a DeepWiki badge to the README's Documentation section, enabling automatic documentation updates on the DeepWiki platform. The badge provides a clickable link to the project's DeepWiki page at https://deepwiki.com/Crossmint/crossmint-sdk.

Key Changes

  • Adds a DeepWiki badge inline with the Documentation section header

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

5. Merge the release PR to publish to NPM

## Documentation
## Documentation <a href="https://deepwiki.com/Crossmint/crossmint-sdk"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

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

[nitpick] The badge is placed inline with the section header, which may affect readability and is not a common Markdown convention. Consider placing the badge on a separate line after the header for better formatting:

## Documentation

<a href="https://deepwiki.com/Crossmint/crossmint-sdk"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>

Alternatively, use Markdown-style badge syntax for better consistency:

## Documentation

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Crossmint/crossmint-sdk)
Suggested change
## Documentation <a href="https://deepwiki.com/Crossmint/crossmint-sdk"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
## Documentation
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Crossmint/crossmint-sdk)

Copilot uses AI. Check for mistakes.
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.

1 participant