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

[WIP] Website: show instructions side by side #587

Closed
wants to merge 7 commits into from

Conversation

DanielMSchmidt
Copy link
Contributor

@DanielMSchmidt DanielMSchmidt commented Feb 27, 2018

This PR aims to show the install instructions side by side, similar to the react-native docs.

  • improve tooling
  • build component
  • style component
  • use component

@stale
Copy link

stale bot commented Apr 13, 2018

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the 🏚 stale label Apr 13, 2018
@DanielMSchmidt
Copy link
Contributor Author

Update from my side: I will be working on it this evening

@stale stale bot removed the 🏚 stale label Apr 13, 2018
@DanielMSchmidt
Copy link
Contributor Author

I am continuing the work on this right now 👍

@DanielMSchmidt
Copy link
Contributor Author

Status: Still need to use the component, but it looks okay-ish in the storybook :)

@DanielMSchmidt
Copy link
Contributor Author

Oh man, this is harder then it seemed -.- But we are getting there, had to remove styled components as they didn't work well with docusaurus. Now somehow the included component is not dynamic, it doesn't do anything on click. This needs more investigation on my side.

@rotemmiz
Copy link
Contributor

It's a big luck we have a professional on this then 😉

@DanielMSchmidt
Copy link
Contributor Author

Uh nice, who is it? :trollface: Thank you for your patience

@DanielMSchmidt
Copy link
Contributor Author

Asking for help is our best option here, I wrote a demo, will keep you posted: facebook/docusaurus#584

@DanielMSchmidt
Copy link
Contributor Author

@rotemmiz Outcome of the ticket on Docusaurus was that they don't rehydrate react, so they don't support interactivity in their documentations. We can go different routes from here:

  1. Build the rehydrating on our own (You can load a script into docusaurus and we could use normal script tags to inline the rehydration logic) - should be feasible, might be hacky.
  2. Open up an upstream PR for adding interactivity - we need to discuss that first with the maintainers, there might be good reasons against it in a general case that we are not aware of currently.
  3. Drop the side-by-side functionality and anything interactive in the docs

@DanielMSchmidt
Copy link
Contributor Author

Closing this for now

@wix wix locked and limited conversation to collaborators Jul 23, 2018
@LeoNatan LeoNatan deleted the website/side-by-side branch July 22, 2019 02:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants