Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add new pages to js and python #58

Merged
merged 4 commits into from
Jun 27, 2024

Conversation

Ngozi-Txfusion
Copy link
Collaborator

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

  • Enhanced User Guidance: The new and updated guides (Getting Started, Why Use Python SDK, Compatibility, and Installation) provide users with clearer, more detailed instructions and explanations, improving the onboarding and usage experience.
  • Comprehensive Support: Adding a compatibility page for ethers v5 and v6 ensures users have the necessary information to work with different versions effectively.
  • Improved Navigation and Reference: Organizing the glossary in alphabetical order ensures users can navigate the documentation more efficiently and quickly find the information they need.
  • User-Centric Enhancements: Expanding the FAQ and troubleshooting sections addresses user pain points, making the documentation more robust and helpful.

@Ngozi-Txfusion Ngozi-Txfusion requested review from a team as code owners June 27, 2024 00:55
@Ngozi-Txfusion Ngozi-Txfusion changed the title Add new pages to js and python feat: Add new pages to js and python Jun 27, 2024
Copy link

github-actions bot commented Jun 27, 2024

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

@danijelTxFusion danijelTxFusion merged commit dd1b155 into main Jun 27, 2024
9 checks passed
@danijelTxFusion danijelTxFusion deleted the add-new-pages-to-js-and-python branch June 27, 2024 09:36
Copy link

🎉 This PR is included in version 1.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

petarTxFusion pushed a commit that referenced this pull request Jul 8, 2024
* feat: added platform compatibility for zyksync-ethers

* feat: added new pages and update to python page

* chore: added callout

* chore(ethers,compatibility): fix errors

---------

Co-authored-by: Danijel Radakovic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants