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.

Sign up for GitHub

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

Jump to bottom

Introduce linting for the docs #1639

Closed
martintmk opened this issue Sep 27, 2023 · 1 comment · Fixed by #1667
Closed

Introduce linting for the docs #1639

martintmk opened this issue Sep 27, 2023 · 1 comment · Fixed by #1667
Assignees
@martincostello
Labels
documentation Hacktoberfest Suggested contribution for Hacktoberfest

Comments

@martintmk
Copy link
Contributor

As more content is being added to the /docs we might consider adding linter to the build to verify things such as:

  • Markdown syntax
  • Grammar
@martincostello martincostello added the Hacktoberfest Suggested contribution for Hacktoberfest label Sep 28, 2023
@martincostello martincostello self-assigned this Sep 29, 2023
martincostello added a commit that referenced this issue Sep 29, 2023
@martincostello
Add markdownlint
abc35ba 
Add a markdown linter to the `gh-pages` workflow.
Contributes to #1639.
@martincostello martincostello mentioned this issue Sep 29, 2023
Merged
martincostello added a commit that referenced this issue Sep 29, 2023
@martincostello
Add markdownlint
c884379 
Add a markdown linter to the `gh-pages` workflow.
Contributes to #1639.
@martincostello
Copy link
Member

Markdown linter added in #1664.

Will look at adding a spellchecker after that's merged.

martincostello added a commit that referenced this issue Sep 29, 2023
@martincostello
Add markdownlint (#1664)
305e0c3 
- Add a markdown linter to the `gh-pages` workflow.
- Fix some lint warnings.
- Fix incorrect file name.

Contributes to #1639.
martincostello added a commit to martincostello/Polly that referenced this issue Sep 29, 2023
@martincostello
Add spellchecker
389421b 
Add a spellchecker for Markdown files.
Resolves App-vNext#1639.
@martincostello martincostello mentioned this issue Sep 29, 2023
Merged
martincostello added a commit that referenced this issue Oct 6, 2023
@martincostello
Add spell checker (#1667)
3040bfa 
- Add a spell checker for Markdown files.
- Fix various typos found by the linter (or change wording to "fix" them).

Resolves #1639.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@martincostello martincostello

Labels
documentation Hacktoberfest Suggested contribution for Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add spell checker App-vNext/Polly
2 participants
@martincostello @martintmk