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.

Sign up for GitHub

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

Jump to bottom

Am I missing something, why is there zero documentation on using this library #93

Open
niedfelj opened this issue Apr 26, 2019 · 6 comments
Open

Am I missing something, why is there zero documentation on using this library #93

niedfelj opened this issue Apr 26, 2019 · 6 comments

Comments

@niedfelj
Copy link

I get that it mostly follows the published API, but has a lot of helper functions that one would need to read the source code to find? eachPage? all? etc?
@scolton99
Copy link

I would also like to know--the REST API is documented so well but for this library, I've been struggling for a while to find anything.

@EvanHahn
Copy link
Contributor

Thanks for reporting! We're a small team with lots to do, but we'll keep this in mind as we work on new versions of Airtable.js and the API.

@niedfelj
Copy link
Author

I understand small teams, but you could link directly in (or even mention) the node/javascript tab in the API documentation (I missed it) and you could also at least autogen documentation from the source code you have here and link to it?

@DaveBitter
Copy link

I was confused for a while as well. The documentation of Airtable looks insufficient, but you have to make sure that you got the Javascript tab enabled instead of the cURL tab. There you see the examples with the airtable.js package. More documentation would be great, but this will help you out in most use cases.
Screenshot 2019-05-28 at 11 04 10

@danalexilewis
Copy link

just adding another voice here. for me the api site you have created is pretty - but I found I needed to work more things out then I expected.

Even just listing all the functions off in a lodash style would be great.

dnicolaeva added a commit to dnicolaeva/airtable.js that referenced this issue Mar 25, 2020
@dnicolaeva
Update README.md - reference JS tab in api docs
2a195b2 
Adding a reference to the existence of a Javascript tab in the Airtable API documentation. 

I was struggling to find documentation for this library and Airtable#93 made me realize I was just not noticing the JS tab. Since it seems to be occurring to multiple people on the thread, adding it explicitly in the readme might help save someone some hours of research.
@dnicolaeva dnicolaeva mentioned this issue Mar 25, 2020
Merged
kasrak pushed a commit that referenced this issue Mar 25, 2020
@dnicolaeva
Update README.md - reference JS tab in api docs (#164)
edf156a 
* Update README.md - reference JS tab in api docs

Adding a reference to the existence of a Javascript tab in the Airtable API documentation. 

I was struggling to find documentation for this library and #93 made me realize I was just not noticing the JS tab. Since it seems to be occurring to multiple people on the thread, adding it explicitly in the readme might help save someone some hours of research.

* Update README.md
@madebycaliper madebycaliper mentioned this issue May 28, 2020
Open
@joshhamon
Copy link

I'm exploring moving to Airtable for my app, but yeah, the lack of detailed documentation is rough.

PeterPan627 added a commit to PeterPan627/airtable.js that referenced this issue May 28, 2023
@PeterPan627
Update README.md - reference JS tab in api docs (#164)
ffaefb8 
* Update README.md - reference JS tab in api docs

Adding a reference to the existence of a Javascript tab in the Airtable API documentation. 

I was struggling to find documentation for this library and Airtable/airtable.js#93 made me realize I was just not noticing the JS tab. Since it seems to be occurring to multiple people on the thread, adding it explicitly in the readme might help save someone some hours of research.

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@niedfelj @EvanHahn @danalexilewis @scolton99 @joshhamon @DaveBitter