Coder Social home page Coder Social logo

Tutorials Per API Partner about api3-docs HOT 5 CLOSED

wkande avatar wkande commented on August 17, 2024
Tutorials Per API Partner

from api3-docs.

Comments (5)

wkande avatar wkande commented on August 17, 2024

The problem with this concept (regardless where it lives) is API provider upkeep. Once these tutorials are created will they get maintained, retired? In the "real world" this needs to be done in an environment with a TTL clause. If the API provider does not update their info on a regular basis then the tutorial will become inactive. This would require more than a static website or a bunch of GitHub repos.

from api3-docs.

wkande avatar wkande commented on August 17, 2024

This might be possible with an advanced component. The docs would now need and authentication method to protect each use case.

I have not heard any further conversations on the issue since Aug 10th and not sure who had came up with the idea. Keeping this issue alive for now hoping for other input.

from api3-docs.

dcroote avatar dcroote commented on August 17, 2024

I think this is at least partially covered by the Web3 API catalog on api3.org. For instance, the page for API provider Interzoid links to Airnode instructions and parameters for calling various endpoints.

from api3-docs.

37Rb avatar 37Rb commented on August 17, 2024

I agree with @dcroote. Rather than doing this in our official docs it should be done in the API-provider-owned Airnode docs for each API, which are linked to with the "+ Airnode" link on the API pages on our site. I think the marketing team should provide these examples. We did something similar with Bitcoin Bankathon here. We can work with the account managers to get good examples into the API Airnode docs.

from api3-docs.

wkande avatar wkande commented on August 17, 2024

Then we have a good consensus. I am closing this issue related to the Docs supporting this idea. I

from api3-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.