New user documentation improvements

[endigo9740]

Linked Issue

Closes #107

Description

Improves the new user experience for the documentation.

Changesets

We use Changesets to automatically create our changelog per each release. Any changes or additions to the Library assets in /lib must be documented with a new Changeset. This can be done as follows:

1. Navigate to the root of the project on your feature branch.
2. Run pnpm changeset to trigger the Changeset CLI.
3. Follow the instructions when prompted.
   • Changesets should be either minor or patch. Never major.
   • Prefix your Changeset description using: feature:, chore: or bugfix:.
4. Changeset .md files are added to the /.changeset directory.
5. Commit and push the the new changeset file.

Checklist

Please read and apply all contribution requirements.

• [x] PR targets the dev branch (NEVER master)
• [x] All website documentation is current with your changes
• [x] Ensure Prettier formatting is current - run pnpm format
• [x] Ensure ESLint linting is current - run pnpm lint
• [x] All test cases are passing - run pnpm test
• [x] Includes a changeset (if relevant; see above)

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
floating-ui-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 22, 2024 7:19pm

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 03c35bc7c639801e603a1604958d3531f333df65

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