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

Adding HalstackProvider documentation #1453

Merged
merged 10 commits into from Feb 15, 2023
Merged

Adding HalstackProvider documentation #1453

merged 10 commits into from Feb 15, 2023

Conversation

jsuarezgonz
Copy link
Collaborator

Checklist
(Check off all the items before submitting)

  • Build process is done without errors and all tests pass in /lib directory.
  • Self-reviewed the code prior to submitting.
  • Meets accessibility standards.
  • Added/updated documentation to /website as needed.
  • Added/updated tests as needed.

Description

  • A new 'Utilities' section is created with the HalstackProvider documentation. This documentation includes examples of how to use the HalstackProvider with the opinionated theme, the advanced theme, and an example of label translation.

  • Themes documentation is modified to explain in a more detailed way the different theming strategies we have.

@jsuarezgonz jsuarezgonz self-assigned this Jan 31, 2023
@jsuarezgonz jsuarezgonz marked this pull request as ready for review January 31, 2023 11:03
@jsuarezgonz jsuarezgonz removed their assignment Jan 31, 2023
@GomezIvann GomezIvann self-assigned this Feb 1, 2023
@GomezIvann GomezIvann self-requested a review February 1, 2023 08:43
Copy link
Collaborator

@GomezIvann GomezIvann left a comment

Choose a reason for hiding this comment

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

The extension of the example files is not correct since we are not using actual JSX code inside of them. For example, advancedTheme.tsx should be instead advancedTheme.ts

website/screens/principles/themes/ThemesPage.tsx Outdated Show resolved Hide resolved
website/screens/principles/themes/ThemesPage.tsx Outdated Show resolved Hide resolved
website/screens/principles/themes/ThemesPage.tsx Outdated Show resolved Hide resolved
website/screens/principles/themes/ThemesPage.tsx Outdated Show resolved Hide resolved
Copy link
Collaborator

@GomezIvann GomezIvann left a comment

Choose a reason for hiding this comment

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

These files are missing from changing their extension (correct me if I'm wrong but any of them has JSX code):

  • bloomTheme.tsx
  • customTranslations.tsx
  • defaultAdvancedTheme.tsx
  • opinionatedTheme.tsx

website/screens/principles/themes/ThemesPage.tsx Outdated Show resolved Hide resolved
website/pages/utilities/halstackProvider.tsx Outdated Show resolved Hide resolved
website/screens/common/pagesList.ts Outdated Show resolved Hide resolved
@GomezIvann GomezIvann merged commit a6ddb68 into master Feb 15, 2023
@GomezIvann GomezIvann deleted the jsuarezgonz-docs branch February 15, 2023 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants