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

Readability improvements in mobile #1816

Merged
merged 15 commits into from
Nov 1, 2024

Conversation

s-santillan
Copy link
Collaborator

@s-santillan s-santillan commented Oct 30, 2024

Thanks for improving Semgrep Docs 😀

Please ensure

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR

Was not easy to resize previews in this GH PR comment, so please check this doc: Screenshot of fixes.

Fixes

  • Header - controversial - remove "Semgrep" text (look at screenshot, Semgrep goes under the search bar on 380px)
    • For some reason, docusaurus sets this in the config file, where it seems I can't swap out a longer asset for a shorter one based on breakpoints a la content as I would in CSS.
  • Reduce padding between breadcrumbs and logo in article (see arrow)
  • Fix Semgrep logo and Semgrep docs by changing arrangement from horizontal to vertical (see arrow)
  • Made text a little smaller, in line with reduced size on phones (this still respects if the user overrides the setting)
  • Fixed the gradient icon squares

Please also check ON YOUR PHONES some docs as I adjusted everything - the p, the ol, the ul, the h1-h5s.

https://deploy-preview-1816--semgrep-docs-prod.netlify.app/docs/

Copy link

netlify bot commented Oct 30, 2024

Don't forget to add /docs at the end of the deploy preview site URL!

Name Link
🔨 Latest commit 7198540
🔍 Latest deploy log https://app.netlify.com/sites/semgrep-docs-prod/deploys/672429ac816f0800088d9e13
😎 Deploy Preview https://deploy-preview-1816--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@s-santillan s-santillan self-assigned this Oct 30, 2024
@s-santillan s-santillan added the hold Do not merge this PR label Oct 30, 2024
@s-santillan s-santillan changed the title fix logo Readability improvements in mobile Oct 31, 2024
@s-santillan s-santillan removed the hold Do not merge this PR label Oct 31, 2024
Copy link
Collaborator

@khorne3 khorne3 left a comment

Choose a reason for hiding this comment

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

I don't know if it's just related to our individual phone settings, but the preview looks a bit better on mine than yours (e.g., the search bar on mine displays "ask" fully)

@s-santillan
Copy link
Collaborator Author

s-santillan commented Oct 31, 2024

I don't know if it's just related to our individual phone settings, but the preview looks a bit better on mine than yours (e.g., the search bar on mine displays "ask" fully)

I used 360px 380px for the simulation (that's the smallest "modern" size). It's also possible, now that I think about it, to try to resize the search bar instead of changing the Semgrep logo.

@s-santillan s-santillan merged commit 48931f2 into main Nov 1, 2024
7 checks passed
@s-santillan s-santillan deleted the sara/tec-210-mobile-breakpoint-bugs-in-landing-page branch November 1, 2024 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants