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

Remove bad words from documentation #328

Closed
dbanksdesign opened this issue Oct 3, 2019 · 4 comments
Closed

Remove bad words from documentation #328

dbanksdesign opened this issue Oct 3, 2019 · 4 comments

Comments

@dbanksdesign
Copy link
Member

Based on this CSS-Tricks article lets remove bad words from the documentation. Words/phrases to remove:

  • just
  • simply
  • clearly
  • of course
  • easy
  • so
  • basically
  • technically
  • very
  • in order to
  • everyone knows

One thing to note, some markdown files are generated by a script and handlebars, but those have a comment at the top of the file that they are being generated.

@manisacharya
Copy link
Contributor

Hello, @dbanksdesign. I want to give a try on this.

@Iqlaas
Copy link

Iqlaas commented Oct 3, 2019

Hi @dbanksdesign, which documentation are you referring to?

@dbanksdesign
Copy link
Member Author

Everything on https://amzn.github.io/style-dictionary/#/ which is built by the markdown files in the docs/ folder (see note in the issue). Also README files in the examples/ folder, and any JSDoc comments in the code.

@dbanksdesign
Copy link
Member Author

I think we have enough PRs for this issue for now, we are still going through them. Thank you everyone for your contributions!

dbanksdesign pushed a commit that referenced this issue Oct 24, 2019
Replaced following words with other relevant words so that gist of the sentence won't differ that much, from all the documentation within the project. Words include: just, simply, clearly, of course, easy, so, basically, technically, very, in order to, everyone knows. 

Also, some of the grammatical improvement has been checked and corrected.

related to #328
MDemetrio pushed a commit to MDemetrio/style-dictionary that referenced this issue Nov 8, 2019
Replaced following words with other relevant words so that gist of the sentence won't differ that much, from all the documentation within the project. Words include: just, simply, clearly, of course, easy, so, basically, technically, very, in order to, everyone knows. 

Also, some of the grammatical improvement has been checked and corrected.

related to amzn#328
dbanksdesign pushed a commit that referenced this issue Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants