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-2289): Text block documentation #363

Merged
merged 11 commits into from
Sep 9, 2022

Conversation

Srinivasan-Ramasamy
Copy link
Contributor

@Srinivasan-Ramasamy Srinivasan-Ramasamy commented Sep 7, 2022

PPDSC-2289

What

  1. Text block documentation UI - http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2289-text-block-documentation/components/text-block/

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:

After:

image

Who should review this PR:

How to test:

URL: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2289-text-block-documentation/components/text-block/

@Srinivasan-Ramasamy Srinivasan-Ramasamy added docs Improvements or additions to documentation WIP Work in progress labels Sep 7, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy added ready for design review Please assist in getting this reviewed and removed WIP Work in progress labels Sep 7, 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 Sep 7, 2022
mstuartf
mstuartf previously approved these changes Sep 7, 2022
'If provided, this overrides the typography preset applied to the text block.',
},
],
},
Copy link
Contributor

@Xin00163 Xin00163 Sep 8, 2022

Choose a reason for hiding this comment

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

TextBlock now supports LogicalProps. Could we please add these to the docs?

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 @Xin00163m, updated the changes. Please review it once.

@Srinivasan-Ramasamy
Copy link
Contributor Author

Srinivasan-Ramasamy commented Sep 8, 2022

Thanks @mstuartf and @Xin00163, @baburay23 for taking the time to review 👍

@Srinivasan-Ramasamy Srinivasan-Ramasamy merged commit 0beeda3 into main Sep 9, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy deleted the docs/PPDSC-2289-text-block-documentation branch September 9, 2022 04:00
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
* docs(PPDSC-2289): Text block documentation ui.
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.

5 participants