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

docs: update README to use better syntax for json code block #1935

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

burmecia
Copy link
Member

@burmecia burmecia commented Feb 6, 2025

What kind of change does this PR introduce?

This PR is to update README to use better syntax for json code block.

What is the current behavior?

Some of json code blocks aren't valid json format, e.g it shows comments in red:

image

What is the new behavior?

Use js syntax for json code block for better looking.

Additional context

N/A

@burmecia burmecia requested a review from a team as a code owner February 6, 2025 06:44
@burmecia burmecia added the documentation Improvements or additions to documentation label Feb 6, 2025
@coveralls
Copy link

Pull Request Test Coverage Report for Build 13173324463

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 66.145%

Totals Coverage Status
Change from base Build 13158754064: 0.0%
Covered Lines: 9980
Relevant Lines: 15088

💛 - Coveralls

Copy link
Member

@kangmingtay kangmingtay left a comment

Choose a reason for hiding this comment

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

🎉

@kangmingtay kangmingtay merged commit e137365 into master Feb 6, 2025
6 checks passed
@kangmingtay kangmingtay deleted the bo/docs/readme-code-syntax branch February 6, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants