[ARROW-13407] [Documentation] Documentation Improvements

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation
• External issue URL: https://github.com/apache/arrow/issues/29076
• Assignee: Unassigned
• Reporter: Nicola Crane
• Created: 20/Jul/21 11:24
• Updated: 11/Jan/23 08:32

Description

Parent ticket for general documentation improvement tasks

Issue Links

• is a parent of: ARROW-13336 [Doc][Python] make clean doesn't clean up "generated" documentation
• is a parent of: ARROW-13404 [Python] [Doc] Make Python landing page less coupled to the rest of arrow documentation
• is a parent of: ARROW-13405 [Doc] Make "Libraries" the entry point for the documentation
• is a parent of: ARROW-13476 [Doc][Python] Ensure that ipc/io documentation uses context managers instead of manually closing streams
• is a parent of: ARROW-13637 [Python][Doc] Make docstrings conform to same style
• is a parent of: ARROW-13411 [Doc][Python] Make docs release match arrow releases

Sub-Tasks

• [R] Update developing.Rmd vignette: Resolved
• [R] Update flight.Rmd vignette: Resolved
• [R] Update install.Rmd vignette: Resolved
• [R] Update arrow.Rmd vignette: Resolved
• [R] Update dataset.Rmd vignette: Resolved
• [R] Update fs.Rmd (Working with S3) vignette: Resolved
• [R] Update python.Rmd vignette: Resolved
• [R] Add examples to functions which don't have examples: Closed
• [R][Docs] Add article on how to run R with C++ debugger to dev docs: Resolved
• [R] Add our philosophy to the dev vignette: Resolved
• [R] Split dev docs into separate articles under developers menu: Closed
• [R] Add section to how to get output when things hang to debugger docs: Resolved
• [Doc][Python] Make return types clickable: Resolved
• [R][Documentation] Document the process of creating R bindings for compute kernels and rationale behind conventions: Resolved