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

[BD-46] docs: updated docs site navigation #1803

Merged

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Nov 29, 2022

Description

Implement left and right sidebars from the design above.
Figma design

Deploy Preview

Paragon site documentation

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Nov 29, 2022
@openedx-webhooks
Copy link

Thanks for the pull request, @PKulkoRaccoonGang!

When this pull request is ready, tag your edX technical lead.

@netlify
Copy link

netlify bot commented Nov 29, 2022

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 46f4c7a
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/6447c3057045010008601dc7
😎 Deploy Preview https://deploy-preview-1803--paragon-openedx.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 settings.

@codecov
Copy link

codecov bot commented Nov 29, 2022

Codecov Report

Patch coverage has no change and project coverage change: +0.33 🎉

Comparison is base (2a866c8) 90.73% compared to head (46f4c7a) 91.07%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1803      +/-   ##
==========================================
+ Coverage   90.73%   91.07%   +0.33%     
==========================================
  Files         233      234       +1     
  Lines        4082     4122      +40     
  Branches      966      981      +15     
==========================================
+ Hits         3704     3754      +50     
+ Misses        371      361      -10     
  Partials        7        7              

see 31 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@PKulkoRaccoonGang PKulkoRaccoonGang changed the title [BD-46] docs: updated docs site navigation [BD-46] DRAFT: updated docs site navigation Nov 29, 2022
@viktorrusakov viktorrusakov linked an issue Dec 1, 2022 that may be closed by this pull request
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/update-docs-site-navigation branch 3 times, most recently from c5fd7ca to 54979ed Compare January 9, 2023 20:37
@PKulkoRaccoonGang PKulkoRaccoonGang changed the title [BD-46] DRAFT: updated docs site navigation [BD-46] docs: updated docs site navigation Jan 11, 2023
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/update-docs-site-navigation branch 2 times, most recently from c8480b4 to 732c88c Compare January 11, 2023 23:59
www/src/components/ComponentsList.tsx Outdated Show resolved Hide resolved
www/src/pages/foundations/colors.tsx Outdated Show resolved Hide resolved
www/src/components/Menu.tsx Show resolved Hide resolved
www/src/components/Menu.tsx Outdated Show resolved Hide resolved
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/update-docs-site-navigation branch 2 times, most recently from 22676b5 to a246573 Compare January 12, 2023 11:47
@adamstankiewicz adamstankiewicz linked an issue Jan 24, 2023 that may be closed by this pull request
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/update-docs-site-navigation branch from a246573 to dfa5c1d Compare January 27, 2023 11:43
@adamstankiewicz
Copy link
Member

@PKulkoRaccoonGang @viktorrusakov This is looking great. I shared the deploy preview around to a couple engineers internally to get their feedback as well. One high-level feedback item is that the re-design loses the search bar on the home page since its now only in the sidebar navigation on child pages.

In talking to Kayva (designer), we would like to add the search bar back to the header persistent across the site, but also keep the search bar in the sidebar nav on the child pages.

@viktorrusakov
Copy link
Contributor

@PKulkoRaccoonGang I see you've also added Container Width option to settings Sheet, but it has different styling from language selector
image

should probably something like this
image

@viktorrusakov
Copy link
Contributor

@PKulkoRaccoonGang also, when I open the menu popup locally, I get couple of prop types warnings, could you please take a look at them
image

www/src/components/Menu.tsx Outdated Show resolved Hide resolved
www/src/components/ComponentsList.tsx Outdated Show resolved Hide resolved
www/src/components/Menu.tsx Show resolved Hide resolved
www/src/components/Menu.tsx Outdated Show resolved Hide resolved
@viktorrusakov viktorrusakov merged commit 5bd792a into openedx:master Apr 25, 2023
11 checks passed
@openedx-webhooks
Copy link

@PKulkoRaccoonGang 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 20.32.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 21.0.0-alpha.23 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blended PR is managed through 2U's blended developmnt program released on @alpha released
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Implement new docs site design Update docsite navigation
5 participants