Skip to content

Add login button to docs site #544

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

Merged
merged 7 commits into from
Nov 26, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Nov 25, 2024

Internal Notes for Reviewers

This PR adds a Login button & menu to our docs site. If this format works for you, we can ask CSTMR to add the same button to our main site: LIVE PREVIEW

image

As part of this change, I'm also switching the search over to the navbar icon — it helps with spacing for the Login button and helps differentiate how search on the front page is subtly different from search that is available elsewhere.

How it works:

2024-11-25_13-20-38 (1)

External Release Notes

We added the option to log in to the ValidMind Platform to our docs site, making it easy for you to find the right login. Click Login to try it out.

@nrichers nrichers added the documentation Improvements or additions to documentation label Nov 25, 2024
@nrichers nrichers changed the title Nrichers/sc 7484/add login button to docs site Add login button to docs site Nov 25, 2024
@nrichers nrichers requested a review from validbeck November 25, 2024 21:35
Copy link
Contributor

PR Summary

This pull request introduces enhancements to the website's navigation menu by adding a 'Login' section with multiple login options. The changes include:

  • Removal of the search box from the sidebar.
  • Addition of a 'Login' menu on the right side of the navigation bar, which includes links to different login portals (US1 and CA1) for the ValidMind platform.
  • A help link titled 'Which login should I use?' that directs users to a guide for logging into ValidMind.
  • Styling updates in styles.css to support the new login menu, including background color, border, text color, padding, and hover effects.

Test Suggestions

  • Verify that the 'Login' menu appears on the right side of the navigation bar.
  • Check that each login option (US1 and CA1) correctly redirects to the respective URLs.
  • Ensure the 'Which login should I use?' link navigates to the correct guide page.
  • Test the styling of the login menu for consistency across different browsers and screen sizes.
  • Confirm that the removal of the search box does not affect other functionalities.

Copy link
Contributor

A PR preview is available: Preview URL

Copy link
Contributor

A PR preview is available: Preview URL

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

I like it! (And I see we are finally going with the topnav search! 😁)

The only thing is this weird gap in the staging preview that doesn't show up in the local. Not sure why. 🤔

Screenshot 2024-11-25 at 4 55 34 PM

I fiddled a bit with the CSS padding on the hero images and it seems to be fine now, but WTF.

Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

A PR preview is available: Preview URL

@nrichers nrichers merged commit fac548b into main Nov 26, 2024
3 checks passed
@nrichers nrichers deleted the nrichers/sc-7484/add-login-button-to-docs-site branch November 26, 2024 17:01
nrichers added a commit that referenced this pull request Nov 26, 2024
* Add login button & switch search

* Tweak login options

* Padding?

* Ughhh padding

* Add VPV to login options

* Wording tweak

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@validbeck
Copy link
Collaborator

@nrichers I was able to locate the original conversation where I tried to implement the overlay search and you advised against it — I know some of the reason was the solution I had in that PR removed the landing search from the main page and I agree the trade-off in that instance wasn't acceptable, but the following still applies:

As much as I like the look of overlay and tested it with our docs site before, you now need to click before you can see the searchbox, on every docs page, for every search. Every. single. time. An extra click every time you want to see the searchbox is a small usability anti-pattern with a big impact over time, and it's completely unnecessary since a better option is readily available and already in use on our docs site. That search box should always be visible to entice people to use it.

Is there a reason why we decided this is now worth the extra click? I'm in favour of it, just trying to understand the logic of what else shifted.

@nrichers
Copy link
Collaborator Author

Is there a reason why we decided this is now worth the extra click? I'm in favour of it, just trying to understand the logic of what else shifted.

Yes, we reimplemented the search on the front page of the docs, in preparation for future enhancements like the chatbot. Given how the old search box was implemented on front page ('I macgyvered it'), we could not switch to the search icon without losing the search box.

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.

2 participants