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

Improved Documentation for Avail SDK Usage #705

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

crStiv
Copy link

@crStiv crStiv commented Jan 5, 2025

Pull Request type

  • Documentation

Description

This pull request updates the README.md file in the avail-js/docs directory. It improves the structure and clarity of the documentation for the avail-js-sdk. Key updates include:

  • Updated instructions for running a local Avail node, providing two methods: building from source and downloading the latest release.
  • Revised the example script instructions for better readability and usability.
  • Added troubleshooting steps for common issues.
  • Enhanced formatting for a clearer presentation.

These changes aim to make the documentation more accessible and helpful for developers using the avail-js-sdk.


Related Issues

None.


Testing Performed

  • Verified the changes to the documentation locally to ensure all instructions are accurate and complete.
  • Followed the updated steps to run examples and confirmed they work as described.

Checklist

  • I have performed a self-review of my own code.
  • The changes were reviewed for clarity and accuracy.
  • All provided examples were tested successfully.
  • Any affected documentation was updated accordingly.

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.

1 participant