typed-prelude icon indicating copy to clipboard operation
typed-prelude copied to clipboard

Published 20 hours ago • verified publisher icon TylorS

Documentation

Open TylorS opened this issue 6 years ago • 8 comments

No production-ready libraries are complete without documentation. A full GH pages setup should be investigated and implemented covering the entirety of the API as well as some basic step-by-step guides to making the most out of some of the libraries in conjunction with one another.

TylorS avatar May 22 '19 15:05 TylorS

Ensure to document how to use replace plugins - probably both rollup & webpack - to ensure that bundles for the browser do not include node dependencies.

TylorS avatar Jul 29 '19 14:07 TylorS

If anyone is keen on the documentation please feel free to add suggestions about what you'd like to see specifically. Please be as precise in what you'd like to see as possible 😄

TylorS avatar Aug 02 '19 14:08 TylorS

Okay, I'm really going to get around to this :) Here's a list to help visualize the progress

  • [x] AsyncIterable
  • [ ] Async Storage
  • [ ] Common
  • [ ] Disposable
  • [ ] DOM
  • [ ] Effects
  • [ ] Either
  • [ ] Env
  • [ ] Future
  • [ ] History
  • [ ] Hooks
  • [ ] Http
  • [ ] Iterable
  • [ ] JWT
  • [ ] Lambda
  • [ ] List
  • [ ] Logger
  • [ ] Logic
  • [ ] Map
  • [ ] Math
  • [ ] Maybe
  • [ ] New Type
  • [ ] Node
  • [ ] Objects
  • [ ] Promises
  • [ ] Remote Data
  • [ ] Routing
  • [ ] Set
  • [ ] Storage
  • [ ] Streams
  • [ ] Strings
  • [ ] Subscription
  • [ ] Timer
  • [ ] Tuple
  • [ ] UUID
  • [ ] Validation

TylorS avatar Feb 28 '20 18:02 TylorS

Hello @TylorS I can help you with some docs, I had a look at the AsyncIterable docs, I think I can contribute a little towards this

contrasam avatar Mar 03 '20 16:03 contrasam

Hey @contrasam - I'd love to get some help! Are there any packages you're particularly interested in helping to document?

So far I've been thinking a simple README.md w/ some hard API documentation, like AsyncIterable, would be sufficient to get started with. When I have more time to dedicate I'd definitely like to get a full website put together, but I'm currently pushing that down the line a bit.

Thanks again!

TylorS avatar Mar 03 '20 18:03 TylorS

Hi, I was planning to start with something like Maybe & Either

contrasam avatar Mar 03 '20 21:03 contrasam

Awesome! Feel free to make a PR whenever you have the time. I'll skip over those for now

TylorS avatar Mar 03 '20 22:03 TylorS

Well, there's still a lot to do, but each package now has generated documentation being rendered at https://tylors.github.io/typed-prelude for now. There's still a lot of cleanup that needs to occur to that before I'm happy with it 😄

Anyways, it generates using TypeDoc and will use the TSDoc comments as markdown when generating things. Additionally, there's a setup in documentation/ which can be configured to add custom sections to the navigation bar with markdown content so we can eventually build out more tutorial-like content.

TylorS avatar Jun 04 '20 15:06 TylorS