autonomys / subspace-docs

Official Documentation for Subspace Labs & the Subspace Network
MIT License
13 stars 37 forks source link

Release initial Auto SDK docs #643

Closed EmilFattakhov closed 1 month ago

EmilFattakhov commented 1 month ago

This PR consists of two parts:

netlify[bot] commented 1 month ago

Deploy Preview for subspace-docs-staging ready!

Name Link
Latest commit ce40aca9ccc94024a047e2f75c3073a732b181f2
Latest deploy log https://app.netlify.com/sites/subspace-docs-staging/deploys/66fea21dfe8a2d0008c150dd
Deploy Preview https://deploy-preview-643--subspace-docs-staging.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

EmilFattakhov commented 1 month ago

Okay, most of the comments were addressed. @jim-counter

  1. I think it's a good idea to provide some more information about the API, but the return object is so massive that it's almost indescribable. Let me think about what information can be added, but hopefully, the Usage Examples will make things slightly easier.
  2. I liked the idea of the tables, but when implemented I faced a few issues:
    • Tables have inconsistent width because the functions and their descriptions differ a lot in length. It doesn't look good in my opinion. Screenshot 2024-10-02 at 1 19 39 PM Screenshot 2024-10-02 at 1 21 57 PM