Skip to content

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

Merged
merged 13 commits into from
Jul 4, 2025
Merged

Documentation update #4457

merged 13 commits into from
Jul 4, 2025

Conversation

chinyeungli
Copy link
Contributor

Fixes
#4434
#4446
#4444
#4445
#4443
#4440
#4437
#2485
#1330

Tasks

  • Reviewed contribution guidelines
  • PR is descriptively titled 📑 and links the original issue above 🔗
  • Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
    Run tests locally to check for errors.
  • Commits are in uniquely-named feature branch and has no merge conflicts 📁
  • Updated documentation pages (if applicable)
  • Updated CHANGELOG.rst (if applicable)

Failing tests don't related to the documentation updated that I made in the PR

Signed-off-by: Chin Yeung Li

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>
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a 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:
Copy link
Member

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.

@AyanSinhaMahapatra AyanSinhaMahapatra merged commit 166b616 into develop Jul 4, 2025
26 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants