Documentation

[orther]

An easy to access reference manual for this library would be quite valuable for our team. It should be helpful to people new to the library but also document the current best practices for all users to reference.

Publishing

If not too much effort I believe it is worth trying to publish the docs as a website using GitHub Pages. I like the static docs site for JS library Crooks which is generated using the open source tool Electric.

Generated Site https://evilsoft.github.io/crocks/docs/
Source Files https://github.com/evilsoft/crocks/blob/master/docs/README.md

NOTE: Electric seems looks nice but we could also just create a static site using Gatsby, react-static or any of the many other options out there.

Docs Content

I expect the content of the docs to change and grow over time. To start I created the follow outline but actual content, organization, and order of information can change.

Overview of concepts

• General Abstractions
  • redux-modules
  • redux-saga-thunk
• Package Structure
  • Modules
  • Helpers
• Features
  • Resource
  • Entities
• Installation / Setup
  • Install package
  • Setup in project
    • Overview
    • Example
• Usage Examples
  • Resource / Entities
    • Helpers (createResourceHelper: resourceListRead, etc.)
    • Redux-Saga-Thunk
    • Resource Loader Components
    • Entities Reader Components