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

New user documentation improvements #111

Merged
merged 4 commits into from
May 22, 2024
Merged

Conversation

endigo9740
Copy link
Contributor

@endigo9740 endigo9740 commented May 22, 2024

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.

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

@endigo9740 endigo9740 linked an issue May 22, 2024 that may be closed by this pull request
Copy link

vercel bot commented May 22, 2024

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

Copy link

changeset-bot bot commented May 22, 2024

⚠️ No Changeset found

Latest commit: 03c35bc

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

@endigo9740 endigo9740 merged commit 08abb26 into dev May 22, 2024
7 checks passed
@endigo9740 endigo9740 deleted the docs/new-user-doc-improvements branch May 22, 2024 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New user documentation improvements
1 participant