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

Update docs on NEAR API #2321

Open
2 of 12 tasks
gagdiez opened this issue Nov 20, 2024 · 0 comments
Open
2 of 12 tasks

Update docs on NEAR API #2321

gagdiez opened this issue Nov 20, 2024 · 0 comments
Assignees

Comments

@gagdiez
Copy link
Collaborator

gagdiez commented Nov 20, 2024

Background

Our documentation on NEAR API is incredibly outdated. To start with, it only includes information on near-api-js, and even that information is outdated.

Currently we have 3 different APIs:

  • Python
  • Javascript
  • Rust

Two of which (Rust, Python) are not even mentioned in our docs

User Story

As a user I would like to be able to easily find documentation on how to use NEAR API to allow my application to interact with the NEAR blockchain, including getting information from the chain, as well as allowing my users to login and use their account.

Acceptance Criteria

  • The NEAR API docs show documentation for the 3 APIs:
    • near-api-js
    • near-api-rs
    • near-py
  • The documentation explains how to:
    • Make a read-only function call
    • Make a function call with an account
    • Transfer NEARs
    • Create / Delete an account
    • Create a sub-account
    • Sign a message
  • The documentation links to GitHub repos instead of static code.

Resources & Additional Notes

Priority

  • 🟠 P1 : High
@gagdiez gagdiez converted this from a draft issue Nov 20, 2024
@gagdiez gagdiez changed the title update API documentation Update docs on NEAR API Nov 20, 2024
@gagdiez gagdiez moved this from NEW❗ to In Progress 🏗️ in DevRel Nov 22, 2024
@gagdiez gagdiez moved this from In Progress 🏗️ to In Review 👀 in DevRel Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review 👀
Status: No status
Development

No branches or pull requests

4 participants