Docusaurus v1 site

[Burnett2k]

Description

New Vercel Site

Existing github pages site

Search plugin added

Adding a new Docusaurus Documentation site. The content of the new site has been extracted from the already excellently written README.md file and put into the /docs portion of the site.

I also got the examples from the example app working within the documentation. However, I left the old examples repo in place in case users want to run locally instead.

Things left to be done (open to suggestions)

Landing Page

• use different images / icons for features on landing page
• use new color palette
• update to use banner and look more like nuka-carousel
• add "more from Nearform Commerce" section
• clean up verbiage / terminology on newly created pages
• get feedback from design / others (in progress)

Documentation site

• clean up verbiage / terminology on newly created pages
• convert to using static images in carousels for faster loading

Other

• Note: react-swipeable doesn't currently work with node 18, so you need to be on 16 when running the demo app locally. However, the docs site (using Docusaurus framework) requires at least node 18, so you have to currently switch between node versions. I can work on fixing this. 🚧 Will do this in a separate pr 🚧
• It appears there's some CICD checks using node 12 which might fail

Type of Change

Documentation

How Has This Been Tested?

• Running locally
• Tested on the Vercel preview site

mobile:

api docs:

working demo:

Checklist: (Feel free to delete this section upon completion)

• I have included a changeset if this change will require a version change to one of the packages.
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have run all builds, tests, and linting and all checks pass
• I have added tests that prove my fix is effective or that my feature works
• My changes generate no new warnings
• Any dependent changes have been merged and published in downstream modules

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7a075c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
react-swipeable	✅ Ready (Inspect)	Visit Preview	✅ 22 resolved	Mar 28, 2024 9:22pm

[github-actions]

size-limit report 📦

Path	Size
lib/index.js	1.63 KB (0%)
dist/react-swipeable.js	1.72 KB (0%)
es/index.js	1.72 KB (0%)

[hartzis]

this is awesomeness! always wanted this package to have a proper doc site 😸🙌❤️

[Burnett2k]

this is awesomeness! always wanted this package to have a proper doc site 😸🙌❤️

Thanks @hartzis . I'm going to keep polishing it up a bit. Curious if you have any thoughts for improvement? I was considering updating the examples to use a different carousel potentially that we can just pull straight from npm, or even nuka-carousel for some cross-promotion.

[BrittanyIRL]

Lookin' good! Found a couple things, flagged 'em in vercel comments mostly. one of them might also be on Nuka and I just missed it.

Good catch with the dueling versions for usage. I think that would be a great thing to work on if you find yourself blocked by needing review here tomorrow. Holler when you're ready for a second pass. Looks so great!

[Burnett2k]

Lookin' good! Found a couple things, flagged 'em in vercel comments mostly. one of them might also be on Nuka and I just missed it.

Good catch with the dueling versions for usage. I think that would be a great thing to work on if you find yourself blocked by needing review here tomorrow. Holler when you're ready for a second pass. Looks so great!

@BrittanyIRL Thanks for reviewing. The only remaining issue right now is with the Copy button looking weird on Safari. I'll keep working on that tomorrow. I left the other vercel comment open for you to review and close if you think it's fixed on your iPhone 13 mini. From what I can tell, it seems fixed.

The node version issue shouldn't be a blocker for releasing this. It's just kind of confusing, but shouldn't prevent the PR from being approved and merged as I was able to get CI working by putting in a couple of other fixes.

However, I do think we should do a follow-up PR to get node18 working which will probably require a major or minor release depending on what we have to do.

[BrittanyIRL]

Here's a fix for the buttons: FormidableLabs/nuka-carousel@2275109

Thanks for clarifying, I don't mean that the node update needs to be part of this update I just mean that it's a valuable update that isn't blocked by review of this branch since it's its own thing :)

[hartzis]

🙌 woo woo!

📓 on the node upgrade: we should really try to avoid a major bump for a dev dep unless there is something fundamentally changing in the output which i don't think should be the case.

[BrittanyIRL]

Thanks for the changes!