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

Improve documentation #1120

Merged
merged 3 commits into from
Sep 14, 2017
Merged

Improve documentation #1120

merged 3 commits into from
Sep 14, 2017

Conversation

d2s
Copy link
Contributor

@d2s d2s commented Sep 12, 2017

docs(README.md) update details

  • Fix details about minimum Node.js versions required.
  • Fix capitalization of tool names (SASS --> Sass).
  • Improve structure of English language sentences.
  • Run gulp dev:doc to update Table of Contents.
  • Improve Markdown syntax to fix markdownlint warnings:
    • MD022/blanks-around-headers: Headers should be surrounded by blank lines
    • MD009/no-trailing-spaces: Trailing spaces [Expected: 0; Actual: 2]
    • MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines
    • MD032/blanks-around-lists: Lists should be surrounded by blank lines
    • MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]
    • MD040/fenced-code-language: Fenced code blocks should have a language specified
    • MD034/no-bare-urls: Bare URL used
    • MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]

docs(DEVELOPMENT.md) update details

  • Improve consistency of the Markdown syntax
  • Improve Markdown syntax to fix markdownlint warnings
  • Fix heading hierarchy (for more consistent document structure)
  • Fix part deploy command (it was missin gulp)
  • Fix capitalization of names
  • Add missing link to the JSCS website.
  • Add link to the JavaScript coding convention

d2s added 3 commits September 12, 2017 13:42
- Fix details about minimum Node.js versions required.
- Fix capitalization of tool names (SASS --> Sass).
- Improve structure of English language sentences.
- Run `gulp dev:doc` to update Table of Contents.
- Improve Markdown syntax to fix markdownlint warnings:
  - MD022/blanks-around-headers: Headers should be surrounded by blank lines
  - MD009/no-trailing-spaces: Trailing spaces [Expected: 0; Actual: 2]
  - MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines
  - MD032/blanks-around-lists: Lists should be surrounded by blank lines
  - MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]
  - MD040/fenced-code-language: Fenced code blocks should have a language specified
  - MD034/no-bare-urls: Bare URL used
  - MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]
- Improve consistency of the Markdown syntax
- Improve Markdown syntax to fix markdownlint warnings
- Fix heading hierarchy (for more consistent document structure)
- Fix part deploy command (it was missin gulp)
- Fix capitalization of names
- Add missing link to the JSCS website.
- Add link to the JavaScript coding convention
- Update capitalization from AirBNB to Airbnb
- Remove duplicate SASS item from the config

Reason for the change:
- Official spelling of the brand name has changed
@varya varya merged commit 38214d2 into SC5:master Sep 14, 2017
@varya
Copy link
Contributor

varya commented Sep 14, 2017

Thank you, Daniel :-)

@d2s d2s deleted the d2s-improve-docs branch September 14, 2017 11:00
@varya
Copy link
Contributor

varya commented Sep 20, 2017

Hi. Your contribution has become a part of 2.1.0 release. Thank you!

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