Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding command line screenshot to all existing commands #1086

Merged
merged 2 commits into from May 15, 2024
Merged

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Apr 25, 2024

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
  • 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.

Copy link

codecov bot commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Lee-W Lee-W changed the title Doc improvements Adding command line screenshot to all existing commands May 13, 2024
Copy link
Member

@noirbizarre noirbizarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Lee-W Lee-W merged commit 3e57007 into master May 15, 2024
18 checks passed
@Lee-W Lee-W deleted the doc-improvement branch May 15, 2024 02:32
@Lee-W
Copy link
Member Author

Lee-W commented May 15, 2024

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

Tricks I learned from Airflow haha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants