drivendataorg/cloudpathlib

Documentation updates content + style

开放

#133 创建于 2021年3月13日

 (1 条评论) (0 个反应) (0 位负责人)Python (87 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (624 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

I had a few thoughts while looking at #132 that may be useful for improving our documentation content and styling

Content:

  • "Getting started" page - usually the first page I click on, which should be mostly code and have steps for install, instatiation and simple read/write examples.
  • Examples/cookbook/common use cases (download files, listing dir, globbing, persistent cache)
  • Note about file handles like in this comment
  • Maybe the authentication/caching pages go under an "Advanced" header in the TOC?
  • URI schemes should feature prominently on the homepage/getting started page/methods table, etc. (you have to dig in to find these at the moment)
  • Would be helpful to have some diagrams, especially on the caching page
  • Example usage on the AnyPath page link AnyPath usage page from the AnyPath API reference page.

Style:

贡献者指南