Documentation update #4457
Merged
Documentation update #4457
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
This section can be removed, as the installation guide is already covered in getting-started/install.html. Signed-off-by: Chin Yeung Li <[email protected]>
…tions page within the 'Output Formats' section. Signed-off-by: Chin Yeung Li <[email protected]>
…n` and `--json-pp` Signed-off-by: Chin Yeung Li <[email protected]>
…ocker" section Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Chin Yeung Li <[email protected]>
…able with `--csv` output Signed-off-by: Chin Yeung Li <[email protected]>
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
AyanSinhaMahapatra
approved these changes
Jul 4, 2025
Member
AyanSinhaMahapatra
left a comment
AyanSinhaMahapatra
left a comment
There was a problem hiding this comment.
TLGTM, hanks @chinyeungli! Merging with a small update
| - Output Formats | ||
| - Other Important Documentation | ||
|
|
||
| .. _syn_install: |
Member
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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