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

Fix: correct vertical alignment issue in schema example #1297

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Karan-Palan
Copy link
Contributor

@Karan-Palan Karan-Palan commented Jan 12, 2025

What kind of change does this PR introduce?

This is a bugfix for the vertical alignment issue in the JSON schema example in the documentation.

Issue Number:

Screenshots/videos:

image

If relevant, did you update the documentation?

No.

Summary

The schema example under "To link to the external geographical location schema" had improper vertical alignment, specifically for the "warehouseLocation" key. This PR fixes the alignment issue, ensuring better readability and consistency in the example.

Does this PR introduce a breaking change?

No

Copy link

codecov bot commented Jan 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4fe7488) to head (99e7b1e).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1297   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          373       373           
  Branches        94        94           
=========================================
  Hits           373       373           

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

Copy link

github-actions bot commented Jan 12, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 99e7b1e

@Karan-Palan Karan-Palan marked this pull request as ready for review January 12, 2025 15:12
@Karan-Palan Karan-Palan requested a review from a team as a code owner January 12, 2025 15:12
@Karan-Palan Karan-Palan changed the title fix[docs/learn]: correct vertical alignment issue in schema example Fix: correct vertical alignment issue in schema example Jan 12, 2025
@Karan-Palan
Copy link
Contributor Author

I wanted to get feedback on the responsiveness of the code snippet display. I tested it across different browsers and screen sizes, including mobile and tablet views. Before the changes, the code snippet didn’t resemble a proper JSON object in smaller screen sizes due to misalignment of key-value pairs. After the changes, while users may need to scroll horizontally on smaller screens, the snippet now maintains correct alignment and actually looks like a proper JSON object which is what I prefer, however if any adjustments are needed, I'll make them

Screencast.from.2025-01-12.22-51-39.webm

Before:
image

After:
image

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.

🐛 Bug: bad spacing in example
1 participant