zksync-sdk / sdk-docs

Documentation for 3rd-party SDKs that integrate with zkSync
https://docs.zksync.io/sdk
Apache License 2.0
1 stars 5 forks source link

feat: Add new pages to js and python #58

Closed Ngozi-Txfusion closed 3 months ago

Ngozi-Txfusion commented 3 months ago

What

  1. General Updates:

    • Updated Links: Edited and fixed links across the documentation to ensure they direct to the appropriate sections.
  2. New and Updated Sections:

    • Getting Started (Python SDK):
      • 00.getting-started.md - Revised to provide clearer, step-by-step instructions for new users beginning with the Python SDK.
    • Why Use Python SDK:
      • New section was added to explain the benefits and use cases of the Python SDK, helping users understand its advantages.
    • Compatibility Guide (Python SDK):
      • Added details on the supported environments and versions, aiding users in ensuring their setups are compatible.
    • Installation Guide (Python SDK):
      • Updated to include detailed, step-by-step installation procedures for the Python SDK.
    • Compatibility Page for Ethers v5 and v6:
      • Added a comprehensive guide on compatibility for ethers v5 and v6 to assist users in navigating version-specific features and changes.
  3. Content Enhancements:

    • FAQ Section:
      • Expanded with additional common questions and detailed answers to assist users in troubleshooting and understanding the SDKs.
    • Troubleshooting Guide:
      • Updated to address common issues users might encounter, providing solutions and best practices.
    • Glossary:
      • Enhanced with new terms and definitions and arranged alphabetically for easier reference.

Why

github-actions[bot] commented 3 months ago

Visit the preview URL for this PR (updated for commit beed21d):

https://zksync-sdk-docs-staging--pr58-add-new-pages-to-js-aa3pas6g.web.app

(expires Thu, 04 Jul 2024 09:36:10 GMT)

šŸ”„ via Firebase Hosting GitHub Action šŸŒŽ

Sign: f6539d831ccfa61081c09db66b409eadb94db989

github-actions[bot] commented 3 months ago

:tada: This PR is included in version 1.4.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: