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: added keep the menu nav section of viewed page expanded #2791

Merged

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Nov 8, 2023

Description

  • Ensured the section containing the currently viewed page on the Paragon docs site is persistently expanded such that users know which section they are currently in.
  • Ensured the current page in the collapsible menu section receives some "active" styling.

Issue: #2776

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

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 8, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 8, 2023

Thanks for the pull request, @PKulkoRaccoonGang!

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

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft November 8, 2023 22:57
Copy link

netlify bot commented Nov 8, 2023

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 20bdd4c
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/65574269d72b9300071773e4
😎 Deploy Preview https://deploy-preview-2791--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 configuration.

Copy link

codecov bot commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (12c5573) 92.83% compared to head (20bdd4c) 92.83%.
Report is 14 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2791   +/-   ##
=======================================
  Coverage   92.83%   92.83%           
=======================================
  Files         235      235           
  Lines        4240     4240           
  Branches     1029     1029           
=======================================
  Hits         3936     3936           
  Misses        300      300           
  Partials        4        4           

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

@@ -6,14 +6,14 @@
padding: $spacer .625rem 2rem;
border-right: $border-width solid $light-400;

&-title {
.pgn-doc__menu-title {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These changes are necessary to comply with the general principles for writing classes in the OpenEdx ecosystem. I noticed that the full name of the class is almost always written to simplify searching in the code

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/nab-section-improvement branch from b41c341 to 222460e Compare November 10, 2023 13:08
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review November 10, 2023 13:12
@monteri
Copy link
Contributor

monteri commented Nov 13, 2023

The only thing that I noticed was active items duplication. Other staff is LGTM
image

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/nab-section-improvement branch from 49d2afc to b8e5dfa Compare November 15, 2023 12:25
src/Spinner/README.md Outdated Show resolved Hide resolved
www/src/components/Menu.tsx Outdated Show resolved Hide resolved
www/src/components/Menu.tsx Outdated Show resolved Hide resolved
www/src/config.js Outdated Show resolved Hide resolved
@viktorrusakov viktorrusakov merged commit 583ea20 into openedx:master Nov 17, 2023
8 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.

@openedx-semantic-release-bot

🎉 This PR is included in version 21.7.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 22.0.0-alpha.18 🎉

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.

[Docs site] Keep the menu nav section of currently viewed page expanded
5 participants