Updating Simple Carousel Documentation and Contribution Documention

[sblinde]

Description

This PR updates the documentation for the Simple Carousel, giving a more contextual update to the Simple Carousel documentation. In addition, the Contribution Documentation was updated as it had discrepancies with the run script listed in package.json.

Type of Change

• This change requires a documentation update

How Has This Been Tested?

This is an update to documentation, not code that has any functional dependency.

---

Of note, this has not been published to Github Pages, but is first in an PR to be reviewed. Running the Python script even after re-running the build doesn't allow this to be previewed entirely locally.

If this should be stripped down to more of just code snippets than a walkthrough, that can be done too.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f38f2a7

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	💬 Add feedback	Oct 10, 2024 3:08pm

[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%)

[carbonrobot]

Of note, this has not been published to Github Pages, but is first in an PR to be reviewed. Running the Python script even after re-running the build doesn't allow this to be previewed entirely locally.

We publish to Vercel, the preview is published here.

Locally, you can run the docs website by

cd docs
yarn install
yarn start

And the examples should be runnable with

cd examples
yarn install
yarn start

The contribution guide appears to be outdated a bit

[sblinde]

Of note, this has not been published to Github Pages, but is first in an PR to be reviewed. Running the Python script even

Of note, this has not been published to Github Pages, but is first in an PR to be reviewed. Running the Python script even after re-running the build doesn't allow this to be previewed entirely locally.

We publish to Vercel, the preview is published here.

Locally, you can run the docs website by

cd docs
yarn install
yarn start

And the examples should be runnable with

cd examples
yarn install
yarn start

The contribution guide appears to be outdated a bit

Thanks a ton for the feedback here. I've also updated the docs particularly to add a section for Documentation based on this, tested it locally, updated that one would require Node 18 to run this (which differed from the code overall in my experience) as a callout.

[sblinde]

@hartzis Hi there! 👋 Wanted you to be aware that I submitted a PR for documentation for React Swipeable's Simple Carousel, and some updates for the Contribution Documentation to get it in line with some of the changes as I was getting up to speed with contributing. Would love your feedback, and thanks a ton!

[hartzis]

awesome clarifying documentation updates 🙏🎉

[sblinde]

awesome clarifying documentation updates 🙏🎉

Thank you a ton!