Comments (8)
Ensure to document how to use replace plugins - probably both rollup & webpack - to ensure that bundles for the browser do not include node dependencies.
from typed-prelude.
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 😄
from typed-prelude.
Okay, I'm really going to get around to this :) Here's a list to help visualize the progress
- 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
from typed-prelude.
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
from typed-prelude.
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!
from typed-prelude.
Hi, I was planning to start with something like Maybe & Either
from typed-prelude.
Awesome! Feel free to make a PR whenever you have the time. I'll skip over those for now
from typed-prelude.
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.
from typed-prelude.
Related Issues (9)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typed-prelude.