ussd_airflow icon indicating copy to clipboard operation
ussd_airflow copied to clipboard

Change documentation to make it straight forward #95

Open musale opened this issue 7 years ago • 3 comments

Re-structure the documentation so that it flows from use case, setup and usage.

Description The current documentation lacks a straightforward flow and presentation. This attempts to address the issue making it easier to navigate the documentation.

Reference to official issue Covers raised issue #95. Even though much hasn't been explained in the issue, this PR attempts to address the basic documentation issues.

Motivation and Context This will improve user documentation for the library

How Has This Been Tested? Locally after running docker-compose up, navigate to http://localhost:7000/

musale avatar Aug 15 '17 10:08 musale

Codecov Report

Merging #108 into master will not change coverage. The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #108   +/-   ##
=======================================
  Coverage   91.84%   91.84%           
=======================================
  Files          34       34           
  Lines        1116     1116           
=======================================
  Hits         1025     1025           
  Misses         91       91
Impacted Files Coverage Δ
ussd/core.py 97.13% <100%> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6bb6928...e3db2dc. Read the comment docs.

codecov[bot] avatar Aug 15 '17 10:08 codecov[bot]

Hey @musale thanks for this pull request. Would please resolve conflicts

mwaaas avatar Sep 17 '17 05:09 mwaaas

Hi @mwaaas! I have done the merge

musale avatar Sep 18 '17 07:09 musale