Skip to content

Updated READMEs to point to docs#274

Merged
codebycarson merged 2 commits into
mainfrom
docs/readme-update
Jul 16, 2025
Merged

Updated READMEs to point to docs#274
codebycarson merged 2 commits into
mainfrom
docs/readme-update

Conversation

@codebycarson

Copy link
Copy Markdown
Collaborator

As there are new docs at https://sei-js.docs.sei.io we don't want to maintain duplicate sources of truth. As LLM's pull from that we will guide users to the docs instead of the README files.

@changeset-bot

changeset-bot Bot commented Jul 16, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b9a5d6b

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

@codecov-commenter

codecov-commenter commented Jul 16, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (93c3acc) to head (db01294).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #274   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           73        73           
  Lines          855       855           
  Branches       139       139           
=========================================
  Hits           855       855           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebycarson
codebycarson requested a review from Copilot July 16, 2025 16:39

Copilot AI left a comment

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.

Pull Request Overview

This pull request updates README files across multiple packages to redirect users to the new centralized documentation site at https://sei-js.docs.sei.io instead of maintaining duplicate documentation in README files.

  • Replaces detailed documentation with concise quick start guides
  • Standardizes README format across all packages with consistent branding and badges
  • Updates all documentation links to point to the new documentation site

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/sei-global-wallet/README.md Simplified to quick start guide with documentation link
packages/precompiles/README.md Condensed extensive documentation to essential usage info
packages/mcp-server/README.md Replaced comprehensive guide with basic setup instructions
packages/ledger/README.md Streamlined from detailed API docs to quick start format
packages/create-sei/README.md Simplified setup instructions with documentation reference
.changeset/sharp-seas-fix.md Added changeset for README updates

Comment thread packages/mcp-server/README.md
@codebycarson
codebycarson requested a review from besated July 16, 2025 16:40
@codebycarson
codebycarson merged commit a64da08 into main Jul 16, 2025
3 checks passed
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.

4 participants