commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

Doc improvements

Open Lee-W opened this issue 1 year ago • 1 comments

Description

  • docs: initial documentation for undocumented commands
  • docs: fix missing links, reorganize documentation and replace command help messages with images

Checklist

  • [ ] Add test cases to all the changes you introduce
  • [ ] Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
  • [ ] Test the changes on the local machine manually
  • [x] Update the documentation for the changes

Expected behavior

all the commands now gots a simple page and all the usage text has been changed to use image

Screenshot 2024-04-25 at 11 47 41 PM

Steps to Test This Pull Request

Additional context

next step: we'll need to generate the images automatically and check if there's difference. If so, these images should be updated.

Lee-W avatar Apr 25 '24 15:04 Lee-W

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.54%. Comparing base (120d514) to head (bbcbf03). Report is 309 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1086      +/-   ##
==========================================
+ Coverage   97.33%   97.54%   +0.20%     
==========================================
  Files          42       55      +13     
  Lines        2104     2486     +382     
==========================================
+ Hits         2048     2425     +377     
- Misses         56       61       +5     
Flag Coverage Δ
unittests 97.54% <ø> (+0.20%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 25 '24 15:04 codecov[bot]

This change is more than welcome !!! Manually maintaining cli helps is way too much work !

Tricks I learned from Airflow haha

Lee-W avatar May 15 '24 02:05 Lee-W