Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Documentation #16

Open
sadasant opened this issue May 23, 2018 · 5 comments · May be fixed by smartprocure/contexture-docs#4
Open

Documentation #16

sadasant opened this issue May 23, 2018 · 5 comments · May be fixed by smartprocure/contexture-docs#4

Comments

@sadasant
Copy link
Contributor

sadasant commented May 23, 2018

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.

@sadasant
Copy link
Contributor Author

One way to do this would be:

  1. Start with the new contexture-imdb.
  2. Every time you find you'll need to read the source code, point it out as "need to provide documentation".

@sadasant
Copy link
Contributor Author

Another thing needed:

  • More robust type authoring guide.

@sadasant
Copy link
Contributor Author

sadasant commented Jun 5, 2018

Here's what I have:
smartprocure/contexture-docs#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.

@daedalus28
Copy link
Member

Taking this since the PR is assigned to me for review

@daedalus28 daedalus28 changed the title Find what things need to be documented Documentation Jun 20, 2018
@daedalus28 daedalus28 removed the A: Sam label Feb 21, 2019
@chrislatorres
Copy link
Contributor

chrislatorres commented Mar 9, 2020

Created two PRs to address this issue, one using Gitbook and one using Flatdoc, to compare and pick which format is better:

@chrislatorres chrislatorres linked a pull request Mar 11, 2020 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants