cloudpathlib icon indicating copy to clipboard operation
cloudpathlib copied to clipboard

Documentation updates content + style

Open pjbull opened this issue 4 years ago • 1 comments
trafficstars

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:

pjbull avatar Mar 13 '21 19:03 pjbull

automatically style these to put each param on a new line

There's an open issue on mkdocstrings requesting this feature.

we strip the In/Out blocks from the notebooks

We could try mknotebooks instead of mkdocs-jupyter. Based on this demo it seems like it doesn't have cell numbers.

jayqi avatar Mar 14 '21 03:03 jayqi