Skip to content

docs: fix README intro grammar in project summary - #97

Merged
damien-schneider merged 2 commits into
mainfrom
copilot/fix-readme-spelling-error
Jun 1, 2026
Merged

docs: fix README intro grammar in project summary#97
damien-schneider merged 2 commits into
mainfrom
copilot/fix-readme-spelling-error

Conversation

Copilot AI commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Pull Request

Description

The README intro currently says “An open-source animated components,” which is grammatically incorrect. This PR updates that sentence to correct the wording while keeping the original meaning and scope.

  • Change Summary
    • README intro copy edit
      • Replaced the incorrect phrase in the top project description block with grammatically correct wording.
    • No functional impact
      • Documentation-only change; no runtime, API, or package behavior changes.
- An open-source animated components built with React, Typescript, Tailwind CSS, and Framer Motion.
+ Open-source animated components built with React, Typescript, Tailwind CSS, and Framer Motion.
  • Related Issue: [feat]: Readme spelling error

Type of Change

Please delete options that are not relevant:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other (please describe):

Checklist

Please ensure your PR fulfills the following requirements:

  • I have read and followed the Contributing Guidelines.
  • My code follows the code style of this project.
  • My code respect as much as possible the W3C standards with corresponding ARIA roles and html semantics.
  • I have performed a self-review of my code.
  • I have commented my code (if necessary), particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation (if applicable).
  • My changes generate no new warnings.

Screenshots (if applicable)

N/A (no UI change).

Additional Context

This is a surgical README wording fix limited to a single line in readme.md.

@dokploy-2025-12-08-0kwnx6

dokploy-2025-12-08-0kwnx6 Bot commented Jun 1, 2026

Copy link
Copy Markdown

Dokploy Preview Deployment

Name Status Preview Updated (UTC)
Application Next ✅ Done Preview URL 2026-06-01T17:45:37.835Z

Copilot AI linked an issue Jun 1, 2026 that may be closed by this pull request
2 tasks
Copilot AI changed the title [WIP] Fix spelling error in README regarding components docs: fix README intro grammar in project summary Jun 1, 2026
Copilot AI requested a review from damien-schneider June 1, 2026 17:39
@damien-schneider

Copy link
Copy Markdown
Owner

@copilot the issue was mentionning something about "An components" right?

Copilot AI commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

@copilot the issue was mentionning something about "An components" right?

Yes — exactly. The problematic wording was the singular article before a plural noun ("An ... components"). I fixed it by removing "An" and keeping "components" plural.

@damien-schneider
damien-schneider marked this pull request as ready for review June 1, 2026 21:41
@damien-schneider
damien-schneider merged commit f0d3538 into main Jun 1, 2026
1 check passed
@damien-schneider
damien-schneider deleted the copilot/fix-readme-spelling-error branch June 1, 2026 21:41
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.

[feat]: Readme spelling error

2 participants