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

docs(PPDSC-2268): Accordion documentation #292

Merged
merged 15 commits into from
Jul 21, 2022

Conversation

Srinivasan-Ramasamy
Copy link
Contributor

@Srinivasan-Ramasamy Srinivasan-Ramasamy commented Jul 18, 2022

PPDSC-2268

What

  1. Accordion doc page UI - http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2268-accordion-page/components/accordion/
  2. Fix for SEO Considerations section extra space at the bottom in all the doc pages.

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

image

SEO Considerations extra space at the bottom:
image

After:

image

Removed SEO Considerations extra space at the bottom:
image

Who should review this PR:

How to test:

URL: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2268-accordion-page/components/accordion/

@Srinivasan-Ramasamy Srinivasan-Ramasamy added docs Improvements or additions to documentation WIP Work in progress labels Jul 18, 2022
@newskit-engineering
Copy link
Collaborator

@Srinivasan-Ramasamy Srinivasan-Ramasamy added ready for design review Please assist in getting this reviewed and removed WIP Work in progress labels Jul 19, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy added ready for review Please assist in getting this reviewed and removed ready for design review Please assist in getting this reviewed labels Jul 20, 2022
baburay23
baburay23 previously approved these changes Jul 20, 2022
@Srinivasan-Ramasamy
Copy link
Contributor Author

Srinivasan-Ramasamy commented Jul 20, 2022

Thanks @baburay23 and @mutebg for taking the time to review 👍

<br />
<br />
<Block spaceStack="space050">
<UnorderedList
Copy link
Contributor

Choose a reason for hiding this comment

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

can you use
<UnorderedList overrides={{ paddingBlockStart: 'something', paddingBlockEnd: 'space050'}}>
instead of that block and <br />

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @mutebg for the review and suggestion and It's really helps on before and after elements spaces. 💯

Changes are done.

@Srinivasan-Ramasamy Srinivasan-Ramasamy merged commit 1a8098e into main Jul 21, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy deleted the docs/PPDSC-2268-accordion-page branch July 21, 2022 12:10
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
* docs(PPDSC-2268): Accordion documentation page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation ready for review Please assist in getting this reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants