It would be great to get some set-up guides, and general how-to guides in the documentation.
So far no documentation exists, only a very bare outline for some docs. It would be good to flesh these out with ideas like:
How to get it running in Node-JS (npm install, etc)
How to get it running in the Browser (git submodule?)
The different types of methods (getters, setters, iterators, assertions) and what they do...
How to use setters/getters
How to chain
How to use assertion methods (is*)
How to use iterator functions
Reverse formatting
Formatting dates
Adding your own date parsers
How to contribute (including docs on TDD)
The "Docs" pages should be general purpose documentation, on issues such as how to get it working, the paradigms & behaviours around Tempus, and guides that require more specific detail than the API docs can offer (for example a section on date formatters or reverse formatters). Leave specific signature patterns for the API docs, and specific use cases for the blog.
keithamus
commented
12 years ago
It would be great to get some set-up guides, and general how-to guides in the documentation.
So far no documentation exists, only a very bare outline for some docs. It would be good to flesh these out with ideas like:
The "Docs" pages should be general purpose documentation, on issues such as how to get it working, the paradigms & behaviours around Tempus, and guides that require more specific detail than the API docs can offer (for example a section on date formatters or reverse formatters). Leave specific signature patterns for the API docs, and specific use cases for the blog.