GithubHelp home page GithubHelp logo

Comments (2)

abidingabi avatar abidingabi commented on August 11, 2024

Honestly, in my opinion the FTC events API is documented pretty well as it is—I had issues with getting authenticated but that was me missing a key part of the process that was plainly written. Anything written here would likely be less comprehensive than the actual documentation—most of the actionable stuff like which endpoint has what data is documented pretty well. That would leave more user friendly documentation to mostly be how to authorize when connecting to the API, which is covered in the authorization section and how to make a web request and perhaps parsing JSON in whatever language—which while definitely useful information, isn't novel or FTC specific enough to be included here in my opinion.

Using the API isn't even that useful for e.g. scouting in FTC—given most events don't have live data and historical data from however many months ago isn't really pertinent to current robot performance.

While it'd be cool to have some more user-friendly documentation on it, to me this seems like something that's realistically pretty niche, would require quite a bit of work to write, and would require nontrivial upkeep when the API get updated.

Also, as a side note, I'd definitely not put it under "using-the-apis" because that is very easily confused with the FTC SDK itself—maybe something like "using-ftc-events-api" fits better.

from gm0.

jackcrane avatar jackcrane commented on August 11, 2024

That is true. gm0 may not be the best place for this either.

closing #190

from gm0.

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.