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: add Docusaurus site #6553

Merged
merged 38 commits into from Apr 13, 2023
Merged

docs: add Docusaurus site #6553

merged 38 commits into from Apr 13, 2023

Conversation

kyletsang
Copy link
Member

@kyletsang kyletsang commented Feb 16, 2023

Docusaurus site

Preview: https://deploy-preview-6553--react-bootstrap.netlify.app/

Checklist:

  • Ads
  • Port content from old site
  • Algolia integration
  • Style everything. I've included the bootstrap styles globally so it messed a lot of things up
  • Fix some code examples
  • Some content could use some review
  • Link local react-bootstrap library. Currently uses the npm release.
  • Generate API docs from source
  • Fix jsdoc annotations in props table
  • Rename www2 folder to www and delete Gatsby site
  • Setup deployment
  • ???

Closes #6510
Closes #6277
Closes #5317
Closes #5310
Closes #5241
Closes #5214

@kyletsang kyletsang marked this pull request as draft February 16, 2023 08:48
@jquense
Copy link
Member

jquense commented Feb 16, 2023

O man this is awesome. Really nice to see all the bespoke Gatsby stuff go away

@kyletsang
Copy link
Member Author

@jquense, I think I got everything done for the site except for 1 thing.

I'm having trouble getting the site to link to the local RB source files properly. The actual linking works (I can import the components), but during render, the site is throwing an error about "invalid hook call" as if I had multiple versions of React installed. Not sure why I'm getting this error.

Are you available to help with this?

@kyletsang kyletsang marked this pull request as ready for review March 5, 2023 04:02
@kyletsang
Copy link
Member Author

@jquense @golota60, this is ready for review

Copy link
Collaborator

@golota60 golota60 left a comment

Choose a reason for hiding this comment

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

looks awesome - couple comments. I didn't focus on code that much, mostly I've just checked out the branch and tried everything out, so:

^all the hyperlinks point to localhost

But overall I love how all of this looks - this is a big improvement over gatsby both from usage and visual standpoint

@kyletsang
Copy link
Member Author

Thanks for the detailed review! I should've checked the examples after fixing the local components integration 🤦‍♂️

@kyletsang
Copy link
Member Author

Fixed all the issues except these:

[subjective] --ifm-navbar-background-color looks pretty strange to me - this is just my opinion so feel free to ignore - personally i'd go with something with less contrast - maybe more dark-blue(e.g. #3870)? @jquense probably has an opinion about it 😄

Yeah not sure what to do with this. I'd like to try implementing the dark mode on the site when we integrate BS 5.3, so we could probably change more. Future PR?

Layout -> Grid - first few examples are not really showing much anymore, cause the mage is narrower

These examples were the same as the old site and you can kinda see the difference when you resize the screen

Copy link
Collaborator

@golota60 golota60 left a comment

Choose a reason for hiding this comment

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

LGTM!
one question: do we wanna keep this section in the footer? doesn't seem to bring much value 😄

image

src/Pagination.tsx Show resolved Hide resolved
www/README.md Outdated Show resolved Hide resolved
@kyletsang
Copy link
Member Author

LGTM! one question: do we wanna keep this section in the footer? doesn't seem to bring much value 😄

image

Footer looked better with 3 columns. I can add more links

@jquense
Copy link
Member

jquense commented Mar 11, 2023

looks great. I wonder tho if its worth holding back merging to the real docs until we can add a RB theme to use? I feel really weird weird having a doc site for a UI library that doesn't use the UI library, dog fooding in this way is probably a minimum.

I also agree about the color, it's really bright and feels a little out of character, should we keep some of the older style greys?

@jquense
Copy link
Member

jquense commented Mar 11, 2023

I can probably take a stab at implementing the base theme btw, i've done it before, so should be relatively quick

@kyletsang
Copy link
Member Author

I also agree about the color, it's really bright and feels a little out of character, should we keep some of the older style greys?

I was thinking of using the older styles for dark mode on the site. Doesn't matter too much tho

@kyletsang
Copy link
Member Author

Did you get a chance to look at the theme stuff @jquense? Anything I can help with?

@jquense
Copy link
Member

jquense commented Apr 12, 2023

no :( i have no less than no time unfortunately. Lets not block on me since i have no idea when i could get to it now

@kyletsang
Copy link
Member Author

No worries @jquense. I'll merge this first since it's so large and we can iterate on it later.

@kyletsang kyletsang merged commit b7c9e4d into master Apr 13, 2023
13 checks passed
@kyletsang kyletsang deleted the docusaurus branch April 13, 2023 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants