Skip to content

docs: improving grammar in documentation #1412

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

Merged
merged 1 commit into from
Apr 8, 2025

Conversation

allexistence
Copy link
Contributor

Description

This pull request fixes grammatical issues in the Capsule project's README. The goal is to make the documentation clearer and easier to read for contributors and users.

Why

The README has minor grammar and punctuation issues that could confuse readers. These changes fix those and improve clarity.

Changes

Fixed small grammar mistakes in the README.
Corrected punctuation and improved sentence flow.
Made the "Contributing" and "Getting Started" sections easier to read.

Testing

Reviewed the README for grammar issues.
Checked that links and formatting are correct.

Related Issues

N/A (documentation update)

Screenshots

Not needed for grammar fixes.

Copy link

netlify bot commented Apr 5, 2025

Deploy Preview for capsule-documentation canceled.

Name Link
🔨 Latest commit 3939b49
🔍 Latest deploy log https://app.netlify.com/sites/capsule-documentation/deploys/67f10665a3f15a000823478e

@prometherion
Copy link
Member

Thanks, we need more of these kinds of PRs!

May I ask you to align all the changes to the CI expections?

@allexistence
Copy link
Contributor Author

Updated PR title to match the commit message: "docs: improving grammar in documentation"

@allexistence allexistence changed the title docs: improve grammar in documentation docs: improving grammar in documentation Apr 5, 2025
Copy link
Collaborator

@oliverbaehler oliverbaehler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 thank you very much

@oliverbaehler oliverbaehler merged commit 45a46d7 into projectcapsule:main Apr 8, 2025
15 checks passed
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.

4 participants