Tutorials still teach the deprecated stellar contract bindings typescript command

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#2,968 4 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
62/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
git, javascript, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với các trang MDX được liệt kê, bắt đầu từ docs/build/smart-contracts/getting-started/hello-world-frontend.mdx quanh các dòng 58-61, và tìm mọi vị trí chạy stellar contract bindings typescript. Kiểm tra mục "CLI" trong README của SDK ở phiên bản v17.4.0 để tìm lệnh của trình tạo thay thế. Hoàn thành khi mỗi trang được liệt kê đều dùng trình tạo của SDK, ghi rõ phiên bản major của SDK (17.x) và pnpm validate chạy thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

bot:needs-decision bot:take js-sdk-v17

Page: several (listed below)
Files:

  • docs/build/smart-contracts/getting-started/hello-world-frontend.mdx:58-61
  • docs/build/guides/dapps/frontend-guide.mdx:820
  • docs/build/guides/dapps/soroban-contract-init-template.mdx:88
  • docs/build/guides/basics/verify-trustlines.mdx:218
  • docs/build/apps/guestbook/bindings.mdx:57
  • docs/build/apps/dapp-frontend.mdx:208 and :364
  • docs/learn/fundamentals/contract-development/types/fully-typed-contracts.mdx:83

What's wrong:
These pages tell readers to run stellar contract bindings typescript. The CLI marks that command deprecated and points to the JS SDK instead (stellar-cli reference on this site). It also still generates packages pinned to an older SDK major, not v17 (see the @stellar/stellar-sdk range in the CLI's TypeScript template), so apps that follow these pages get a second, older SDK copy next to v17.

Change needed:
Teach the SDK's own generator on each page, and say which SDK major the generated package uses.

Correct reference:

How to check the fix:

  • Each tutorial's binding step runs with npx @stellar/stellar-sdk generate and the generated package installs @stellar/stellar-sdk 17.x.
  • npm ls @stellar/stellar-sdk in the tutorial project shows one copy.
  • No page outside docs/tools/cli/stellar-cli.mdx (generated from the CLI) tells readers to run the deprecated command.
  • pnpm validate passes.

Why it matters: At HackMeridian 2026, apps that generated bindings this way ended up with an older SDK copy next to v17; one team pinned its whole app to an older major because of it.

Related: #2561 (adds the generator to the client SDKs page), #2564 (cross-links; mentions the generator for fully-typed-contracts.mdx), #2960 (frontend guide).

Ngôn ngữ chính
MDX
Star
145
Fork
326
Merge trung bình
2 ngày 18 giờ
Pull request đã merge (30 ngày)
109

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stellar/stellar-docs

Tất cả issue của stellar/stellar-docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.