Add developer documentation for new `bulk_insert` API

The following discussion from !25590 (merged) should be addressed:

• @mkaeppler started a discussion: (+3 comments)

  Regarding documentation @ayufan. How should this be documented? I don't think this requires public docs does it? Is it sufficient to provide some RubyDoc-like class header with some examples?