[jira] [Commented] (ARROW-17167) [C++][Docs] Improve C++ Documentation

["Antoine Pitrou (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-17167?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17569599#comment-17569599 ] 

Antoine Pitrou commented on ARROW-17167:
----------------------------------------

I agree with the general sentiment, but one thing I would like to see first is an attempt at better architecting the C++ docs.
Right now they have two main sections:
* an auto-generated API section, which is fine
* a prose section that is more random and doesn't have a very delineated purpose (general introduction? user guide? detailed discussion of specific issues? exhaustive description of available functionality?)

The prose sections turns out to be frustrating to maintain because there isn't a very consistent level of detail, and there's always a tension between making it immediately approachable and making it comprehensive enough.

> [C++][Docs] Improve C++ Documentation
> -------------------------------------
>
>                 Key: ARROW-17167
>                 URL: https://issues.apache.org/jira/browse/ARROW-17167
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: C++, Documentation
>            Reporter: Kae Suarez
>            Priority: Major
>              Labels: documentation, newbie
>
> Parent ticket for tasks that aim to improve C++ Arrow documentation.
>  
> General goal could be parity with Python documentation, so there's a baseline – open to further suggestions. Suggestions from new users would be incredibly valued, due to their experiences being more likely to have been impacted by any lacking documentation.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)