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

docs: fix grammar in "Contributing Translations" section #232

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

asholz
Copy link

@asholz asholz commented Feb 23, 2025

✨ Proposed Changes

Noticed a grammatical mistake in the Contributing Translations section.

Changed "Kaia docs is available in the following languages:""Kaia Docs are available in the following languages:" to properly agree with "Docs" as a plural noun.

🗂️ Types of changes

  • Minor Issues and Typos
  • Major Content Contribution
  • Others (e.g. platform-specific changes)

✅ Checklist

  • I have read the CONTRIBUTING GUIDELINES.
  • I have added necessary documentation (if appropriate).
  • Any dependent changes have been merged and published in downstream modules.

@asholz
Copy link
Author

asholz commented Feb 23, 2025

I have read the CLA Document and I hereby sign the CLA

Copy link

github-actions bot commented Feb 23, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@scott-klaytn
Copy link
Collaborator

@asholz Thank you for your contribution and careful review!

While "Docs" appears plural, in this case "Kaia Docs" refers to the documentation site as a whole—a single entity, rather than a collection of documents. Thus, we'd better maintain "is" to align with the standard practice in technical writing.

  • AS-IS: Kaia docs is available ...
  • Your suggestion: Kaia Docs are available ...
  • Our conclusion: Kaia Docs is available ...

Does that make sense? We're happy to discuss further if you have any other questions. Anyway, please don't let this discourage you from making future contributions - attention to detail like yours helps improve our documentation.

@asholz
Copy link
Author

asholz commented Feb 24, 2025

While "Docs" appears plural, in this case "Kaia Docs" refers to the documentation site as a whole—a single entity, rather than a collection of documents. Thus, we'd better maintain "is" to align with the standard practice in technical writing.

  • AS-IS: Kaia docs is available ...
  • Your suggestion: Kaia Docs are available ...
  • Our conclusion: Kaia Docs is available ...

Does that make sense? We're happy to discuss further if you have any other questions. Anyway, please don't let this discourage you from making future contributions - attention to detail like yours helps improve our documentation.

Thank you for the clarification! That makes sense now—I hadn't considered that "Kaia Docs" is treated as a singular entity rather than a collection of documents. I appreciate the explanation and your openness to discussion.

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.

2 participants