Updated READMEs to point to docs#274
Conversation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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 |
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.