apache / apache/arrow-julia

[Docs] Add developer documentation like in CSV.jl

Open
#402 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Julia
Stars
312
Forks
78
PR merge metrics
No merged PRs in 30d

Description

I really like the developer documentation in [CSV.jl](https://github.com/JuliaData/CSV.jl/blob/main/src/README.md).

Would it be of interest to add something similar to Arrow.jl?

It took a week of starring at it and reading the Arrow IPC specs to understand what’s going on, so I’m probably not the best person to write it.
But I’d be happy to make the first draft.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the developer documentation in CSV.jl's src/README.md and the Arrow IPC specifications referenced in the issue, then inspect Arrow.jl's existing documentation structure. Done means producing a comparable developer-focused first draft that explains how Arrow.jl works.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.