[ARROW-12531] [JS] Make the docs more user friendly

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Component/s: JavaScript
• External issue URL: https://github.com/apache/arrow/issues/28295
• Assignee: Unassigned
• Reporter: Dominik Moritz
• Created: 24/Apr/21 23:34
• Updated: 11/Jan/23 08:27
• Resolved: 06/Apr/22 14:13

Description

Right now, the docs are very much just an API doc but they don't explain how to use most of the library. We should cover

• add function/class comments
  • What does Table.isValid do? Can tables be invalid somehow???
  • Document Table.get and Table.getChildAt.
  • What is the difference between getColumnAt and getChildAt (for Tables and Columns)?
  • scan vs forEach?
  • Why is BindFunc optional in Table.scan?
• remove internal functions from the docs
• Document Vectors (https://arrow.apache.org/docs/js/modules/_vector_.vector.html is just a namespace)
• Make sure IntVector and FloatVector appear in docs
• What is the difference between Table and DataFrame?
• Add more examples

As a good inspiration, we can look at https://uwdata.github.io/arquero/api/.

Issue Links

• duplicates: ARROW-16039 [JS] Documentation is quite obscure and not useful

Sub-Tasks

• [JS] Show Vectors in the docs: Closed