react-overlays icon indicating copy to clipboard operation
react-overlays copied to clipboard

Improve consistency between styling of React Bootstrap and React Overlays docs

Open bpas247 opened this issue 5 years ago • 3 comments

Is your feature request related to a problem? Please describe

Currently, the styling between the React Bootstrap and React Overlays docs are way off. We should aim to improve the consistencies between our docs, so that our end users won't get confused when they navigate between our docs sites

Describe the solution you'd like

Improve the styling between the React Bootstrap and React Overlays docs. This could include changes such as:

  • improved consistency of styling
  • Add a Navbar (similar to the one implemented for the React Bootstrap docs, but with less links)
  • Add a Searchbar for the left side panel.
  • Add a right side panel (to show where the user currently is while scrolling through that section of the docs).

Describe alternatives you've considered

There's a few other things we could include here, such as:

  • Add a "Getting Started" section.
  • Add a "Why React Overlays" section.

bpas247 avatar Oct 08 '19 19:10 bpas247

Hey, @bpas247 . I would love to contribute to this. I believe this is a big issue and could be broken down to smaller ones.

  • Correct me if I am wrong but you want a navbar on react-overlays-docs just like the one here.

  • You also want a searchbar and right side panel.

I will send a PR and update for one component at a time and update it regularly. I will send the PR for navbar by tonight.

Nikhil-Vats avatar Oct 15 '19 10:10 Nikhil-Vats

I also noticed that if I go to this URL - https://react-bootstrap.github.io/react-overlays/. There is just a blank page. I think it would be better if we either redirect it to https://react-bootstrap.github.io/react-overlays/modal/ or design a new homepage. Your views?

Nikhil-Vats avatar Oct 15 '19 10:10 Nikhil-Vats

Hey @Nikhil-Vats :) sorry for the late reply.

I believe this is a big issue and could be broken down to smaller ones.

Yeah there's a lot of moving parts for this one, I agree that it would be more easy if this was just broken up into smaller issues. I think I might end up closing this issue after a discussion around the scope has happened so we can narrow down the scope for this.

Correct me if I am wrong but you want a navbar on react-overlays-docs just like the one here.

Yep! I figured that would make the most sense consistency-wise if we kept a similar design for the navbar.

You also want a searchbar and right side panel.

I think the searchbar will probably be low priority for now, but a right side panel similar to the one implemented for the React Bootstrap website would make it much easier for the user to tell where exactly they are on the page.

I also noticed that if I go to this URL - https://react-bootstrap.github.io/react-overlays/. There is just a blank page. I think it would be better if we either redirect it to https://react-bootstrap.github.io/react-overlays/modal/ or design a new homepage. Your views?

That looks like a bug tbh, I think we should push a hotfix to re-direct the root route to the modal route for now and then have some more discussion for a redesign for a new homepage later.

bpas247 avatar Oct 19 '19 08:10 bpas247