docs(contributing): add link check information - #8659
Conversation
Co-Authored-By: RDIL <[email protected]>
Reece Dunham (RDIL)
changed the title
|
Aditya Patwardhan (@adityapatwardhan) feedback addressed, Travis Plunk (@TravisEz13) ready for review. |
|
Aditya Patwardhan (@adityapatwardhan) please re-review since requested changes were addressed. |
| * if the `.spelling` file is updated, commit and push it | ||
|
|
||
| #### Checking links in documentation | ||
| Documentation is link-checked. We make use of the |
There was a problem hiding this comment.
I would suggest saying that this and markdown syntax checking (like the newline before and after headers.) can be checked by running start-pspester -includecommontests
| #### Spellchecking documentation | ||
|
|
||
| Documentation are spellchecked. We make use of the | ||
| Documentation is spellchecked. We use the |
There was a problem hiding this comment.
This file apparently isn't being checked for markdown syntax issues.
You can add it by updating this list
PowerShell/test/common/markdown/markdown.tests.ps1
Lines 57 to 67 in 03cd3a2
Not a requirement. If you are using, vscode, you can just install the markdownlinq extension and you should get the issues as well.
|
Thanks a lot. |
Travis Plunk (TravisEz13)
added
the
CL-Docs
4 participants
PR Summary
title
PR Context
Travis Plunk (@TravisEz13) told me to do this
Travis if your reading this just know I have to update the other file please no merge yet
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.[feature]to your commit messages if the change is significant or affects feature tests