Skip to content

Update docs and images #57

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.

Sign up for GitHub

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

Jump to bottom
Merged
shenxianpeng merged 2 commits into from
Apr 28, 2022
Merged

Update docs and images #57

shenxianpeng merged 2 commits into from
Apr 28, 2022

Conversation

@shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Apr 26, 2022

Optimized example display and updated docs

  1. For most people who use the light theme, the light example screenshots may make it easier for them to understand what it looks like.
  2. Even though people changed the theme to dark, the marketplace still displays light
  3. Add clang-format annotations example
  4. Fixed clang-tools image link
  5. Removed docs/images/result.png which was not used

I want to display the image original size, so I used <a href="url"><img src="" height="" width="" ></a> instead of ![ ](), but it doesn't look like it's any different, so maybe I'll change it back again.

Welcome any suggestion of a better sample way of showing the action.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 26, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@shenxianpeng shenxianpeng requested a review from 2bndy5 April 26, 2022 16:19
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Apr 26, 2022
2bndy5
2bndy5 approved these changes Apr 26, 2022
View reviewed changes
Copy link
Collaborator

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

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

LGTM

@2bndy5 2bndy5 mentioned this pull request Apr 27, 2022
Merged
@shenxianpeng shenxianpeng merged commit 642db8e into master Apr 28, 2022
@shenxianpeng shenxianpeng deleted the update-docs branch April 28, 2022 02:10
shenxianpeng added a commit that referenced this pull request Apr 28, 2022
@shenxianpeng
Update docs and images (#57)
a820860
shenxianpeng added a commit that referenced this pull request Apr 28, 2022
@2bndy5 @shenxianpeng
feat: Add file-annotations option (#59)
aaa3b1c 
* add file-annotations option

* Update docs and images (#57)

* Update docs and images
* Update display size

* Update docs and images (#57)

* adjust examples in README

* add file-annotations option

* adjust examples in README

Co-authored-by: Peter Shen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@2bndy5 2bndy5 2bndy5 approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shenxianpeng @2bndy5