Skip to content

Commit

Permalink
Rename headlines
Browse files Browse the repository at this point in the history
  • Loading branch information
@Isengo1989
Isengo1989 committed Feb 9, 2024
1 parent cf440f9 commit e260ea1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ They are defined in the [`.github/workflows`](./.github/workflows) folder and he

All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in [`.reviewdog.yml`](./.github/workflows/reviewdog.yml). It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in [Language and Grammar](./resources/guidelines/documentation-guidelines/03-language-and-grammar.md) section.

Check warning on line 28 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L28 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
README.md:28:142: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING

### Markdown
### Markdown check

The markdown files are checked with [markdown-lint](https://github.com/avto-dev/markdown-lint) to identify issues such as formatting errors, style inconsistencies, etc. By doing so, it facilitates the creation of well-structured and consistent Markdown documents.. The configuration for markdown-lint can be found in [`markdown-style-check.yml`](./.github/workflows/markdown-style-check.yml).

Check warning on line 32 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L32 

Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: `.`, `…`
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods 
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
Raw output 
README.md:32:262: Two consecutive dots (DOUBLE_PUNCTUATION)
 Suggestions: `.`, `…`
 URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods 
 Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
 Category: PUNCTUATION

Check warning on line 32 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L32 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
README.md:32:349: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING

Expand All @@ -39,16 +39,16 @@ The markdown files are checked with [py-spelling](https://facelessuser.github.io
sort .wordlist.txt -o .wordlist.txt
```

### Media file formats check
### Media file format check

The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines.

Check warning on line 44 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L44 

Did you mean the formatting language “Markdown” (= proper noun)? (MARKDOWN_NNP[1])
Suggestions: `Markdown`
URL: https://en.wikipedia.org/wiki/Markdown 
Rule: https://community.languagetool.org/rule/show/MARKDOWN_NNP?lang=en-US&subId=1
Category: GRAMMAR
Raw output 
README.md:44:75: Did you mean the formatting language “Markdown” (= proper noun)? (MARKDOWN_NNP[1])
 Suggestions: `Markdown`
 URL: https://en.wikipedia.org/wiki/Markdown 
 Rule: https://community.languagetool.org/rule/show/MARKDOWN_NNP?lang=en-US&subId=1
 Category: GRAMMAR

Check warning on line 44 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L44 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
README.md:44:280: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING

### Validate external links
### External link check

[Lychee](https://github.com/lycheeverse/lychee) is used to check if external links are working properly or broken. The configuration for lychee can be found in [`validate-external-links.yml`](./.github/workflows/validate-external-links.yml).

Check warning on line 48 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L48 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
README.md:48:195: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING


### Synced files check
### Synced files

Certain files within the `shopware/shopware` repository are duplicated in the `shopware/docs` repository for reference purposes. Any modifications made to the former files will automatically synchronize with the corresponding files in the latter repository by the [`update-adrs`](./.github/workflows/update-adrs.yml) workflow.

Check warning on line 53 in README.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] README.md#L53 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
README.md:53:283: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING

Expand Down

0 comments on commit e260ea1

Please sign in to comment.