docs: fixes spelling, formatting, and grammatical errors in documentation #122

lax0248917 · 2020-09-02T21:11:56Z

feat: fixes spelling, formatting, and grammatical errors in documentation

Makes changes to documention to fix typos, grammatical errors, and formatting issues

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
My commits have standard messages as mentioned in Contributing Guidelines

How Has This Been Tested?

No additional tests needed as this is a change to documentation.

This Pull Request is to replace the previous one, as the format integrity of the original project is preserved in this change.

asif-ahmed-1990 · 2020-09-03T05:17:55Z

@lax0248917 Thanks for the new PR.
However, there is a slight problem. You have selected feat, which will bump up the version based on the automated builds we have. Can you edit this commit and change it to docs?
You can do it via git commit --amend. Then do git push -f. Also in your commit message, use fix #116 rather than re #116.
Thanks!

menakallg

Thanks for the contribution Zach. We should have done a content review of the contribution guidelines (CONTRIBUTING.md). We missed doing it and unfortunately, as a result, we are forced to suggest edits on your suggestions. :-) Please take a look at the requested changes. Once again, thanks for the contribution. Keep them coming.

menakallg · 2020-09-03T11:17:08Z

CONTRIBUTING.md

@@ -4,7 +4,7 @@

 Crayons is a component library based on Web Components. The goal of Crayons is to provide the developer with easy to use web components by reducing the number of lines of code while giving your app a Freshworks product like user interface.

-Crayons are built using StencilJS which provides all features of web component.
+Crayons is built using StencilJS which provides all the features of a web component.


Could we modify this content to one of the following?

Crayons is a component library based on Web Components. The goal of Crayons is to provide developers with easy to use web components that give apps a Freshworks product like user interface, while reducing the number of lines of code. Crayons is developed using StencilJS that helps build standard-based Web Components.

Crayons is a component library based on Web Components. The goal of Crayons is to provide developers with easy to use web components that reduce the number of lines of code involved in giving apps a Freshworks product like user interface. Crayons is developed using StencilJS that helps build standard-based Web Components.

Thank you @menakallg, do you want the mentioned paragraph to replace the two separate lines? Therefore joining the sentence regarding Crayons being developed with StencilJS with the previous sentences explaining what Crayons is?

I wouldn't mind Zach.

menakallg · 2020-09-03T11:18:35Z

CONTRIBUTING.md

@@ -13,13 +13,13 @@ Crayons are built using StencilJS which provides all features of web component.

 ## How to Contribute

-Crayons have a predefined set of components, As a developer, you can not only use the components in your projects, you can also contribute to Crayons as it falls under MIT license and we welcome all contributions, small or big.
+Crayons has a predefined set of components. As a developer, you not only can use the components in your projects but you can also contribute to Crayons, as it falls under a MIT license. We welcome all contributions, big or small.


Could we modify this as follows?

Crayons has a predefined set of components. As a developer, you not only can use the components in your projects but can also contribute to Crayons, as it falls under the MIT license. We welcome all contributions, big or small.

menakallg · 2020-09-03T11:19:29Z

CONTRIBUTING.md


 ### Commit the changes to Github

-Crayons repository uses github pre commit hooks, follow the below steps to commit our changes to github
+Crayons repository uses github pre commit hooks, follow the below steps to commit your changes to github


Could we modify this as follows?

The Crayons repository uses GitHub’s pre-commit hooks. To commit your changes,

menakallg · 2020-09-03T11:21:57Z

CONTRIBUTING.md


-1. Make your changes to the file, add the untracked files to staging area.
+1. Make your changes to the file and add the untracked files to staging area.


Could we modify this to one of the following?

Modify the requisite files and add the untracked files to the staging area.

Make changes to the files and add the untracked files to the staging area.

menakallg · 2020-09-03T11:23:41Z

CONTRIBUTING.md

@@ -104,9 +104,9 @@ Crayons repository uses github pre commit hooks, follow the below steps to commi

 8. Give a commit message when it prompts.


Could we modify step 7 and 8 as follows?

Fill in the following details when prompted.

Give a commit message when prompted.

@menakallg, do you want to start using roman numerals with step 7 and 8 only?

No. GitHub auto-corrected the numbering. :-)

menakallg · 2020-09-03T11:24:52Z

CONTRIBUTING.md

@@ -104,9 +104,9 @@ Crayons repository uses github pre commit hooks, follow the below steps to commi

 8. Give a commit message when it prompts.

-9. Run `git push -u origin <your-branch>`, to push your changes to the forked repo. git hooks will run all the test before pushing the changes. if any test fails, rewrite the tests and make sure all the test passes before pushing again.
+9. Run `git push -u origin <your-branch>`, to push your changes to the forked repo. git hooks will run all the test before pushing the changes. if any test fails, rewrite the tests and make sure all the tests pass before pushing again.


Could we modify this as follows?
Run git push -u origin <your-branch>, to push your changes to the forked repo. git hooks run all required tests before pushing the changes. If any test fails, rewrite the test and ensure that all the tests pass before pushing again.

menakallg · 2020-09-03T11:25:34Z

CONTRIBUTING.md


-10. Go to the forked repo in github and raise a PR. wPlease wait for the PR to be approved or address comments if any.
+10. Go to the forked repo in github and raise a PR. Please wait for the PR to be approved. If there are any comments, address them.


Could we modify this as follows?
Navigate to the forked repo on GitHub and raise a PR. If there are any comments on your PR, address them. Please wait for the PR to be approved.

menakallg · 2020-09-03T11:27:12Z

README.md

@@ -3,7 +3,7 @@


 # 🖍️ Crayons
-[Freshworks Crayons](https://crayons.freshworks.com) is a library of UI components that are the building blocks to help create an intuitive and uniform user interface for all your apps. This is a collection of [Web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) that will help developers build apps faster that adheres to the UX standards set by the Freshworks Design System.
+[Freshworks Crayons](https://crayons.freshworks.com) is a library of UI components that are the building blocks to help create an intuitive and uniform user interface for all your apps. This is a collection of [Web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) that will help developers build apps faster that will adhere to the UX standards set by the Freshworks Design System.


Could we modify this as follows?
Freshworks Crayons is a library of UI components that help create an intuitive and uniform user interface for all your apps. This collection of Web Components helps developers to build apps faster and to build apps that adhere to the UX standards set by the Freshworks Design System.

menakallg · 2020-09-03T11:28:23Z

src/components.d.ts

@@ -34,11 +34,11 @@ export namespace Components {
         */
        "checked": boolean;
        /**
-          * Disables the check box on the interface. If the attribute’s value is undefined, the value is set to false.
+          * Disables the checkbox on the interface. If the attribute’s value is undefined, the value is set to false.


At Freshworks, for documentation standards pertaining to UI elements, we use the MSTP. So, could we retain the term “check box”?

@menakallg, of course. I'll change it back. I simply made this change to indicate the error of consistency. If check box is the correct annotation, I will be sure to use it in all locations

menakallg · 2020-09-03T11:30:35Z

src/components.d.ts

         */
        "disabled": boolean;
        /**
-          * Label displayed on the interface, for the check box.
+          * Label displayed on the interface for the checkbox.


Certain prepositions, such as for or on, have a tendency to gel (incorrectly) with the nouns immediately preceding the prepositions. Document users who are used to synthetic languages (inflections) might have a problem comprehending this kind of sentence construction.
Could we retain the comma, to indicate that the prepositional phrase is superfluous information and to prevent the statement from meaning that the interface is for the component?
Alternatively, we can say Label for the component, displayed on the interface. Like I mentioned, “for the component” is superfluous information and going by the principle of “important information first”, I suggest that we leave it at the end of the sentence.

…tion Makes changes to documention to fix typos, grammatical errors, and formatting issues fix freshworks#116

All changes suggested by code reviewer are applied to documentation to meet specifications fix freshworks#116

github-actions · 2020-09-17T16:34:11Z

🎉 This PR is included in version 2.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2020-09-18T03:55:41Z

🎉 This PR is included in version 2.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Dropdown button small fix fix #122

# [2.7.0](v2.6.3...v2.7.0) (2020-09-30) ### Features * **button:** fix type change ([429e7dc](429e7dc)), closes [#112](#112) * **dropdown button:** add missing css prop ([36c157f](36c157f)), closes [#112](#112) * **dropdown button:** dropdown button adhering to Freshworks Design System ([43e8bda](43e8bda)), closes [#112](#112) * **dropdown button:** dropdown button small fix ([003a937](003a937)), closes [#122](#122) * **dropdown button:** review comments ([43923cd](43923cd)), closes [#112](#112) * **dropdown button:** review comments - 2 ([b8bfe71](b8bfe71)), closes [#112](#112)

github-actions · 2020-09-30T07:41:14Z

🎉 This issue has been resolved in version 2.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2020-09-30T14:05:19Z

🎉 This issue has been resolved in version 2.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

asif-ahmed-1990 mentioned this pull request Sep 3, 2020

docs: fixes grammatical, spelling and formatting errors for markdown … #119

Closed

6 tasks

menakallg suggested changes Sep 3, 2020

View reviewed changes

docs: fixes spelling, formatting, and grammatical errors in documenta…

2ec04c4

…tion Makes changes to documention to fix typos, grammatical errors, and formatting issues fix freshworks#116

lax0248917 force-pushed the Feature-2/Issue-#116 branch from 86e094b to 2ec04c4 Compare September 3, 2020 13:43

docs: applies suggested changes from code review to documentation

a20761b

All changes suggested by code reviewer are applied to documentation to meet specifications fix freshworks#116

lax0248917 changed the title ~~feat: fixes spelling, formatting, and grammatical errors in documentation~~ docs: fixes spelling, formatting, and grammatical errors in documentation Sep 3, 2020

menakallg approved these changes Sep 4, 2020

View reviewed changes

asif-ahmed-1990 merged commit d1bf3a0 into freshworks:next Sep 4, 2020

github-actions bot added the released on @next label Sep 17, 2020

github-actions bot added the released label Sep 18, 2020

shravan-balasubramanian added a commit that referenced this pull request Sep 28, 2020

feat(dropdown button): dropdown button small fix

ee0dbe0

Dropdown button small fix fix #122

shravan-balasubramanian added a commit that referenced this pull request Sep 30, 2020

feat(dropdown button): dropdown button small fix

003a937

Dropdown button small fix fix #122

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fixes spelling, formatting, and grammatical errors in documentation #122

docs: fixes spelling, formatting, and grammatical errors in documentation #122

lax0248917 commented Sep 2, 2020 •

edited

Loading

asif-ahmed-1990 commented Sep 3, 2020 •

edited

Loading

menakallg left a comment

menakallg Sep 3, 2020

lax0248917 Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

lax0248917 Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

menakallg Sep 3, 2020

lax0248917 Sep 3, 2020

menakallg Sep 3, 2020

github-actions bot commented Sep 17, 2020

github-actions bot commented Sep 18, 2020

github-actions bot commented Sep 30, 2020

github-actions bot commented Sep 30, 2020


		1. Make your changes to the file, add the untracked files to staging area.
		1. Make your changes to the file and add the untracked files to staging area.

		@@ -104,9 +104,9 @@ Crayons repository uses github pre commit hooks, follow the below steps to commi

		8. Give a commit message when it prompts.


		10. Go to the forked repo in github and raise a PR. wPlease wait for the PR to be approved or address comments if any.
		10. Go to the forked repo in github and raise a PR. Please wait for the PR to be approved. If there are any comments, address them.

docs: fixes spelling, formatting, and grammatical errors in documentation #122

docs: fixes spelling, formatting, and grammatical errors in documentation #122

Conversation

lax0248917 commented Sep 2, 2020 • edited Loading

Checklist:

How Has This Been Tested?

asif-ahmed-1990 commented Sep 3, 2020 • edited Loading

menakallg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 17, 2020

github-actions bot commented Sep 18, 2020

github-actions bot commented Sep 30, 2020

github-actions bot commented Sep 30, 2020

lax0248917 commented Sep 2, 2020 •

edited

Loading

asif-ahmed-1990 commented Sep 3, 2020 •

edited

Loading