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] feat: table of content for non-components #2013

Merged

Conversation

monteri
Copy link
Contributor

@monteri monteri commented Feb 13, 2023

Description

Table of content for other than components pages. It is gathered by traversing heading elements on the page.

Deploy Preview

https://deploy-preview-2013--paragon-openedx.netlify.app/

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

openedx-webhooks commented Feb 13, 2023

Thanks for the pull request, @monteri!

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

@netlify
Copy link

netlify bot commented Feb 13, 2023

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 97102f6
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/64dcb1d5d98da0000703f62e
😎 Deploy Preview https://deploy-preview-2013--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.

@codecov
Copy link

codecov bot commented Feb 22, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (f5fb6c9) 91.65% compared to head (97102f6) 91.65%.
Report is 12 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2013   +/-   ##
=======================================
  Coverage   91.65%   91.65%           
=======================================
  Files         236      236           
  Lines        4195     4195           
  Branches     1012     1012           
=======================================
  Hits         3845     3845           
  Misses        346      346           
  Partials        4        4           

see 2 files with indirect coverage changes

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

@adamstankiewicz adamstankiewicz linked an issue May 5, 2023 that may be closed by this pull request
@monteri monteri force-pushed the zadorozhnii/toc-for-non-component branch from 5d54ba0 to d790c2a Compare July 14, 2023 11:18
Copy link
Member

@adamstankiewicz adamstankiewicz left a comment

Choose a reason for hiding this comment

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

The ToC and the code all look good. Just failing on a few linting errors and the erroneous creation of the www/package-lock.json file.

import { FavoriteBorder } from '@edx/paragon/icons'; // eslint-disable-line

const MyComponent = () => {
function MyComponent() {
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this PR is now failing on a lint error here.

www/package.json Show resolved Hide resolved
@monteri monteri force-pushed the zadorozhnii/toc-for-non-component branch from d790c2a to 2358b30 Compare August 10, 2023 09:02
@adamstankiewicz
Copy link
Member

@monteri It looks like the container widths and positioning might have regressed in this work?

Current state on master

image

Deploy preview

image

Copy link
Member

@adamstankiewicz adamstankiewicz 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! Thanks!

@adamstankiewicz adamstankiewicz merged commit e502bca into openedx:master Aug 18, 2023
9 checks passed
@openedx-webhooks
Copy link

@monteri 🎉 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 21.1.0 🎉

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

Successfully merging this pull request may close these issues.

Add Table of Contents to non-component pages
5 participants