-
-
Notifications
You must be signed in to change notification settings - Fork 598
Documentation update #4457
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
Documentation update #4457
Conversation
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
This section can be removed, as the installation guide is already covered in getting-started/install.html. Signed-off-by: Chin Yeung Li <tli@nexb.com>
…tions page within the 'Output Formats' section. Signed-off-by: Chin Yeung Li <tli@nexb.com>
…n` and `--json-pp` Signed-off-by: Chin Yeung Li <tli@nexb.com>
…ocker" section Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
…able with `--csv` output Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TLGTM, hanks @chinyeungli! Merging with a small update
- Output Formats | ||
- Other Important Documentation | ||
|
||
.. _syn_install: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this part should remain, as it's helpful and just references to installation which is an pre-requisite to using the CLI, and this is just references anyway.
Fixes
#4434
#4446
#4444
#4445
#4443
#4440
#4437
#2485
#1330
Tasks
Run tests locally to check for errors.
Failing tests don't related to the documentation updated that I made in the PR
Signed-off-by: Chin Yeung Li