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

Use Header/Footer #10617

Closed
3 of 9 tasks
julien51 opened this issue Dec 20, 2022 · 10 comments
Closed
3 of 9 tasks

Use Header/Footer #10617

julien51 opened this issue Dec 20, 2022 · 10 comments
Assignees

Comments

@kalidiagne
Copy link
Contributor

@julien51 for now we can not integrate for docs, react 18 not supported yet in docusaurus

@julien51
Copy link
Member Author

julien51 commented Feb 20, 2023

Is there any reason why we need React 18 for our UI library?

I think we could make React a sibling dependency?

@julien51
Copy link
Member Author

So it looks like some tailwin library require the use of React 18... so for now it is probably more reasonable to wait for Docusaurus to support React 18.

Please focus on the guides!

@julien51
Copy link
Member Author

Related #10715

@julien51
Copy link
Member Author

@searchableguy would you be able to help here so we ship or header/footer components in a way that could allow them to be embedded in guides? (WordPress site)

@julien51
Copy link
Member Author

julien51 commented Mar 7, 2023

Adding @searchableguy so we can add the UI package to Wordpress.

There is more work involved. Please @searchableguy provide a detailed update of the underlying stacks. We should also list dependencies to ensure they are required (for example do we need to import unlock-js and if not, let's do things "natively").

@julien51 julien51 added the Blocked This issue can't be merged for external factors/missing requirments label Mar 22, 2023
@searchableguy
Copy link
Contributor

I opened a PR to add cdn build. There is an example inside it which you can copy to add import and mount react components directly from our UI library.

@searchableguy searchableguy removed their assignment Apr 7, 2023
@julien51 julien51 removed the Blocked This issue can't be merged for external factors/missing requirments label Apr 12, 2023
@julien51
Copy link
Member Author

@kalidiagne Thisis back on your plate. Please take of it ASAP.

@kalidiagne
Copy link
Contributor

kalidiagne commented May 17, 2023

Header/Footer are now added in showcase and guides website.

We need more steps:

  • Add notion documentation that includes the details about how we can change the menu and how to set it
  • Include the showcase/guides menu in the ui package to prevent losing the menu configuration

@kalidiagne
Copy link
Contributor

@julien51

An update on the implementation for guides/showcase that i checked with Chris.
it's all now set and works fine with Chrome/Brave, but we have to consider these issues:

  • Cross-browser support: for example, not all versions of Safari/Firefox are not supporting importmaps which makes not possible to show the footer/header components
Screen_Shot_2023-06-08_at_6 33 32_PM
  • First loading can be very slow, about 8/10sec to load the header/footer
Screen_Shot_2023-06-08_at_6 22 06_PM

I suggest pausing the implementation for showcase/guides and considering the Headless CMS approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants