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 tabs for component pages #2915

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Dec 10, 2023

Description

  • added the ability to create tabs for component pages

Issue: #2779

Deploy Preview

https://deploy-preview-2915--paragon-openedx.netlify.app/components/actionrow/

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
Copy link

openedx-webhooks commented Dec 10, 2023

Thanks for the pull request, @PKulkoRaccoonGang!

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

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Dec 10, 2023
Copy link

netlify bot commented Dec 10, 2023

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a637e17
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/6585928ffc4c8f0008164678
😎 Deploy Preview https://deploy-preview-2915--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.

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft December 10, 2023 14:45
Copy link

codecov bot commented Dec 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1e58c10) 92.99% compared to head (c4e27e4) 92.99%.
Report is 1 commits behind head on master.

❗ Current head c4e27e4 differs from pull request most recent head a637e17. Consider uploading reports for the commit a637e17 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2915   +/-   ##
=======================================
  Coverage   92.99%   92.99%           
=======================================
  Files         235      235           
  Lines        4268     4268           
  Branches     1033     1033           
=======================================
  Hits         3969     3969           
  Misses        295      295           
  Partials        4        4           

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

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/gatsby-mdx-tabs branch from 5f0d045 to c4e27e4 Compare December 22, 2023 13:27
@brian-smith-tcril
Copy link
Contributor

Overall I really like how this looks on the preview! I noticed a couple things and I'm hoping to hear what other people think about them:

  • The main tab is named "Implementation"
    • Do we want this to be the name?
    • Assuming we want this name, should we update the README.md files to be implementation.md to match the pattern set with design-guidelines.md?

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
Projects
No open projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants