drivendataorg / deon

A command line tool to easily add an ethics checklist to your data science projects.
https://deon.drivendata.org/
MIT License
289 stars 52 forks source link

Add quickstart above the fold #134

Closed ejm714 closed 2 years ago

ejm714 commented 2 years ago

Currently, we have a lot of text before we get to the usage instructions on deon.drivendata.org.

This adds an upfront quickstart section so people can get going right away.

Closes #80

codecov[bot] commented 2 years ago

Codecov Report

Merging #134 (0720a0f) into master (87f932f) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #134   +/-   ##
=======================================
  Coverage   96.80%   96.80%           
=======================================
  Files           6        6           
  Lines         188      188           
=======================================
  Hits          182      182           
  Misses          6        6           

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 87f932f...0720a0f. Read the comment docs.

ejm714 commented 2 years ago

Docs preview: https://deploy-preview-134--eloquent-dubinsky-5cf105.netlify.app/

ejm714 commented 2 years ago

@pjbull poking on this since this closes an issue you opened