Skip to content

Docs: fix MD docs (root folder)#44569

Closed
Jay-o-Way wants to merge 4 commits intomicrosoft:mainfrom
Jay-o-Way:MD-files-cleanup
Closed

Docs: fix MD docs (root folder)#44569
Jay-o-Way wants to merge 4 commits intomicrosoft:mainfrom
Jay-o-Way:MD-files-cleanup

Conversation

@Jay-o-Way
Copy link
Copy Markdown
Collaborator

Summary of the Pull Request

Just a "quick" cleanup of some Markdown files.

Only files in the top folder for now. Let me know if you want me to go through more folders!

PR Checklist

  • Closes: no issue
  • Communication: I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Visual

Comment thread COMMUNITY.md Dismissed
### Microsoft InVEST team

This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2. @alekhyareddy28, @arjunbalgovind, @jyuwono @laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333
This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2. @alekhyareddy28, @arjunbalgovind, @jyuwono @laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error

traies is not a recognized word. (unrecognized-spelling)
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a username, ignore this

Comment thread COMMUNITY.md Dismissed
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@Jay-o-Way Jay-o-Way changed the title fix MD docs Docs: fix MD docs (root folder) Jan 9, 2026
@Jay-o-Way Jay-o-Way requested a review from niels9001 January 17, 2026 17:17
@github-actions
Copy link
Copy Markdown

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (2)

traies
udit

These words are not needed and should be removed ATX cppcoreguidelines

Some files were automatically ignored 🙈

These sample patterns would exclude them:

^src/modules/powerrename/unittests/testdata/avif_test\.avif$
^src/modules/powerrename/unittests/testdata/heif_test\.heic$

You should consider adding them to:

.github/actions/spell-check/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct, update file exclusions, and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:Jay-o-Way/PowerToys.git repository
on the MD-files-cleanup branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/21098049017/attempts/1' &&
git commit -m 'Update check-spelling metadata'
Warnings ⚠️ (2)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

⚠️ Warnings Count
⚠️ ignored-expect-variant 6
⚠️ large-file 2

See ⚠️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link
Copy Markdown
Collaborator

@niels9001 niels9001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jay-o-Way I've dismissed the spelling check alerts for you. Looks like a few conflicts popped up in the meantime :(. If we can get this fixed then I think we can get this merged straight away!

@yeelam-gordon
Copy link
Copy Markdown
Contributor

🔍 Automated PR Review Summary

Step Severity Finding
11-docs-automation 🟢 low Duplicate contributor entry detected: @snickler/Jeremy Sinclair appears once ...

Review generated by pr-review skill. See Generated Files/prReview/44569/ for full details.

Comment thread COMMUNITY.md

Roy has helped out contributing multiple features to PowerToys Run

### [@snickler](https://github.com/snickler) - [Jeremy Sinclair](http://sinclairinat0r.com)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate contributor entry: @snickler / Jeremy Sinclair appears twice (earlier and again here). Please keep one canonical entry in the intended alphabetical position to avoid duplicate attribution.

@Jay-o-Way Jay-o-Way marked this pull request as draft March 4, 2026 09:39
@niels9001
Copy link
Copy Markdown
Collaborator

@Jay-o-Way is this PR ready to go in?

@Jay-o-Way
Copy link
Copy Markdown
Collaborator Author

Jay-o-Way commented Mar 27, 2026

No. It especially Readme is totally outdated. Better start over.
Obviously one of the reasons is the misuse of Readme by putting a changelog in here every time. But that's a different discussion. #25193

@Jay-o-Way Jay-o-Way closed this Mar 27, 2026
@Jay-o-Way Jay-o-Way deleted the MD-files-cleanup branch April 2, 2026 11:51
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.

4 participants