futil-js
Documentation
In all of the repos related to contexture. Let's start from a usage perspective, then after that, think about other internal things that might benefit from being documented.
One way to do this would be:
- Start with the new contexture-imdb.
- Every time you find you'll need to read the source code, point it out as "need to provide documentation".
Here's what I have: https://github.com/smartprocure/contexture-docs/pull/1 You can explore it using: https://github.com/smartprocure/contexture-docs/tree/draft
Some of the files are missing, but it should be our culture to work on these documents as we use and work on contexture repositories.
Also: having this as a separate documentation repo seems necessary since Contexture is so separated in different pieces.
Created two PRs to address this issue, one using Gitbook and one using Flatdoc, to compare and pick which format is better:
- https://github.com/smartprocure/contexture-docs/pull/5
- https://github.com/smartprocure/contexture-docs/pull/4
