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

Updated the geting started section (removed quote and explained intention and reassured reader with context) #197

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

TimothyRbz
Copy link
Contributor

Hi Amit,

a) This section needs more context. Most readers won’t be familiar with a startup using a (GitHub) Blog for sources.

b) The quote feels out of place and distracting. It needs better context or could be removed.

Fixes

Fixes #[issue number] by @[issue author]

Description

Technical details

Tests

Screenshots

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow the contribution guidelines.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
Further Conditions
(e) This contribution does not grant me any rights to use the
    name of the project, the name of the author, the name of the
    organization, or the name of the author's organization in any
    advertising or publicity relating to this project or the
    contribution.
(f) This contribution does not grant me rights to any trademark or service
    mark belonging to the project, the author, the organization, or the
    author's organization.

Hi Amit,

a) This section needs more context. Most readers won’t be familiar with a startup using a (GitHub) Blog for sources. 

b) The quote feels out of place and distracting. It needs better context or could be removed.

:::info Quote: Attributed to many people
If I had more time, I would have written a shorter letter.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

I am OK with the removal if the quote, it just means to say: condensed and short text is not a bug, it is a feature.

@@ -1,8 +1,9 @@
# Getting Started

In our documentation, we aim to provide concise and clear information, with a focus on source attribution and accuracy.
We welcome feedback and contributions to improve the quality and relevance of our content.
This is the knowhow repository of the AI sign language startup, **sign**. Our mission is to share high-quality knowledge and insights on topics of deafness, market trends, technology, competition, and more.
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. knowhow is not the correct word. it is maybe public documentation
  2. "Our mission" might interfere with the mission of sign. "We aim", or "We strive" would be better

@sign sign deleted a comment from TimothyRbz Feb 10, 2025
@AmitMY AmitMY merged commit d61aa38 into master Mar 6, 2025
1 check passed
Copy link
Contributor

github-actions bot commented Mar 6, 2025

Visit the preview URL for this PR (updated for commit 72ba312):

https://translate-sign-mt--pr197-timothyrbz-patch-4-6d6khhze.web.app

(expires Thu, 13 Mar 2025 16:37:19 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 739446cfe7a349700ebd347d2a39e3b90ba24425

@coveralls
Copy link

Pull Request Test Coverage Report for Build 13703538842

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 22 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.2%) to 52.211%

Files with Coverage Reduction New Missed Lines %
src/app/pages/landing/about/about-benefits/about-benefits.component.ts 2 92.31%
src/app/app.component.ts 20 65.12%
Totals Coverage Status
Change from base Build 12745238392: 0.2%
Covered Lines: 1286
Relevant Lines: 2376

💛 - Coveralls

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.

3 participants