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

Added slide selection and fixed image overflow for small screen sizes #180

Merged
merged 1 commit into from Nov 25, 2021

Conversation

ajmcquilkin
Copy link
Contributor

@ajmcquilkin ajmcquilkin commented Nov 24, 2021

Motivation

This PR was created to improve the professionalism of the documentation site.

Changes

Updated docs image slideshow buttons

Updated the docs/src/pages/slideshow.jsx component to support user-selecting specific images within the slideshow. Previously users had to wait until the slideshow cycled to re-view an image. Now users can simply click on the dot corresponding to their desired image and that image will show. Note that after clicking on a dot the image will still cycle after a given period of time (configured in the component).

image
These buttons can now be used to view specific images within the slideshow

Fixed small-screen docs image display

Currently images within the docs homepage (docs/src/pages/index.jsx) do not display properly on small screens. This was fixed using the object-fit CSS rule.

image
Broken small-screen images

image
Fixed small-screen images

Related

No related PRs. No required documentation updates.

Additional Comments

No additional comments.

@gitpod-io
Copy link

gitpod-io bot commented Nov 24, 2021

@vercel
Copy link

vercel bot commented Nov 24, 2021

Someone is attempting to deploy a commit to a Personal Account owned by @kimlimjustin on Vercel.

@kimlimjustin first needs to authorize it.

@vercel
Copy link

vercel bot commented Nov 25, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/kimlimjustin/xplorer/BAxJM8TZx5wzkSqwAh9exNnsjNHa
✅ Preview: https://xplorer-git-fork-ajmcquilkin-broken-docs-images-kimlimjustin.vercel.app

Copy link
Contributor

@im-coder-lg im-coder-lg left a comment

Choose a reason for hiding this comment

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

Looks great!

@im-coder-lg
Copy link
Contributor

We'll just wait for approves from @kimlimjustin / @stanleyowen.

@im-coder-lg
Copy link
Contributor

Wait, I kinda noticed an error with the slideshow, In 1 minute, I will make the video and post it here. It's best if this error is fixed now.

@im-coder-lg
Copy link
Contributor

2021-11-25.08-56-31.mp4

Bug 1. The brightness in Xplorer blinds the text
Bug(not really) 2. It's supposed to be Xplorer's docs or Documentation, not Xplorer the docs.

@im-coder-lg
Copy link
Contributor

im-coder-lg commented Nov 25, 2021

Xplorer the docs -{'>'}

Just edit that to Xplorer's docs(kinda sounds unprofessional) or Documentation(professional).
Edit: From 12626e4

@im-coder-lg
Copy link
Contributor

Slideshow code:

name: 'Windows (dark)',
src: '/img/Xplorer_dark.png',
alt: 'Xplorer dark on Windows',
},
{
name: 'Garuda Linux (light+)',
src: '/img/Xplorer_linux.png',
alt: 'Xplorer light+ on Linux',
},
{
name: 'macOS (dark)',
src: '/img/Xplorer_mac_dark.png',
alt: 'Xplorer dark on macOS',
},
{
name: 'Windows (light)',
src: '/img/Xplorer_light.png',
alt: 'Xplorer light on Windows',
},
{
name: 'Windows (dark+)',
src: '/img/Xplorer_dark+.png',
alt: 'Xplorer dark+ on Windows',
},
{
name: 'macOS (light+)',
src: '/img/Xplorer_mac_light.png',
alt: 'Xplorer light+ on macOS',
},
];

So, we need to modify the CSS to make the text readable when it's in light mode and dark mode. Since it's JSX, it could be possible.

@kimlimjustin
Copy link
Owner

Sorry for late reply, I was in school and for the Xplore the docs, it's on purpose to write that, also for the brightness, I think opening another PR is better if anyone to fix it. Thanks anyways

@kimlimjustin kimlimjustin merged commit 73b14f9 into kimlimjustin:master Nov 25, 2021
@im-coder-lg
Copy link
Contributor

Well, kinda looks better with Documentation since it's not on Forem, it's on the website, right? Everyone uses Documentation if they are linking it on their product's own site. Just a suggestion, I highly recommend a change. The brightness, I need to check the CSS.

@ajmcquilkin ajmcquilkin deleted the broken-docs-images branch November 25, 2021 03:50
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.

None yet

3 participants