Skip to content

docs: remove misleading “highlighted” wording in subschema examples#2271

Open
pranjalisr wants to merge 4 commits intojson-schema-org:mainfrom
pranjalisr:fix-doc
Open

docs: remove misleading “highlighted” wording in subschema examples#2271
pranjalisr wants to merge 4 commits intojson-schema-org:mainfrom
pranjalisr:fix-doc

Conversation

@pranjalisr
Copy link
Copy Markdown

@pranjalisr pranjalisr commented Feb 23, 2026

What kind of change does this PR introduce?
Docs change

Issue Number:

Screenshots/videos:
N/A

If relevant, did you update the documentation?
Yes

Summary

The examples don’t visually highlight any portion of the schema, so references to “highlighted” subschemas can be confusing. This updates the wording to describe the referenced subschema without implying visual highlighting.

Does this PR introduce a breaking change?
No

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@pranjalisr pranjalisr requested a review from a team as a code owner February 23, 2026 20:59
@github-project-automation github-project-automation bot moved this to Ready to review in PR - Triage Group Feb 23, 2026
@github-actions
Copy link
Copy Markdown

Hi @pranjalisr! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: completed checklist items

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 23, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 4dedc75

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 23, 2026

Codecov Report

❌ Patch coverage is 79.16667% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 99.28%. Comparing base (2ee67ff) to head (7715ad7).
⚠️ Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
components/JsonEditor.tsx 79.16% 5 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              main    #2271      +/-   ##
===========================================
- Coverage   100.00%   99.28%   -0.72%     
===========================================
  Files           30       30              
  Lines          663      698      +35     
  Branches       205      219      +14     
===========================================
+ Hits           663      693      +30     
- Misses           0        5       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@Utkarsh-123github Utkarsh-123github left a comment

Choose a reason for hiding this comment

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

Hi @pranjalisr
For this issue, the expected fix is to write a highlight function (or use it if it is already present in the codebase) and not to change the doc,

@github-project-automation github-project-automation bot moved this from Ready to review to Changes requested in PR - Triage Group Feb 24, 2026
@pranjalisr
Copy link
Copy Markdown
Author

Hi @pranjalisr For this issue, the expected fix is to write a highlight function (or use it if it is already present in the codebase) and not to change the doc,

I got confused as in issue label it was mentioned documentation so I thought it's docs change but now I've added highlights. Checked locally, working fine.
Screenshot 2026-02-24 at 13 20 34
Screenshot 2026-02-24 at 13 20 26

Copy link
Copy Markdown
Member

@Utkarsh-123github Utkarsh-123github left a comment

Choose a reason for hiding this comment

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

Hi @pranjalisr
Your PR is currently failing the required checks.
Whenever you get a chance, could you please take a look and address them?
Thanks

@pranjalisr
Copy link
Copy Markdown
Author

Hi @pranjalisr Your PR is currently failing the required checks. Whenever you get a chance, could you please take a look and address them? Thanks

I've added all required tests for my code changes, verified locally on cypress, running fine. Please review
Screenshot 2026-02-25 at 14 27 34

@pranjalisr
Copy link
Copy Markdown
Author

@Utkarsh-123github if this works fine then can you please assign me #1988 or #1832
Anyone of them will work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Changes requested

Development

Successfully merging this pull request may close these issues.

Feedback on Documentation - Modular schema highlighted subschema

2 participants