drivendataorg/cloudpathlib

Documentation updates content + style

Open

#133 opened on Mar 13, 2021

 (1 comment) (0 reactions) (0 assignees)Python (87 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (624 stars)
PR merge metrics
 (PR metrics pending)

Description

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:

Contributor guide