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

Fixup, Format and Update Markdown files #4069

Merged
merged 2 commits into from
Aug 12, 2021

Conversation

Nirmal4G
Copy link
Contributor

@Nirmal4G Nirmal4G commented Jun 17, 2021

Fixes #4068

  1. Using MarkdownLint or similar tools, fix and format the markdown files
    • Fix headings
    • Fix anchors in headings
    • Fix dead links (Fixes Dead link in the PR markdown form #4139)
    • Add Code ` quotes to source texts
    • Fix Code snippets with correct file-type tags
    • Fix new lines around headings and paragraphs
  2. Replace GitHub emoji identifiers (aka :emoji_id:) with actual emoji symbols

PR Type

What kind of change does this PR introduce?

  • Code style update (formatting)
  • Documentation content changes

What is the current behavior?

Markdown files have a lot of issues being reported from tools like MarkdownLint. They also use GitHub emoji identifiers.

What is the new behavior?

Fixed and Formatted markdown files with MarkdownLint. Replaced GitHub emoji identifiers with actual emojis.

PR Checklist

Please check if your PR fulfills the following requirements:

  • Contains NO breaking changes

Other information

  • If you're editing this patch tree, please rebase on latest HEAD and then commit, without updating from the latest HEAD.
  • When merging, please update the commit title to PR title instead of the default Merge pull request #xxxx from repo/branch, and commit message to either PR message or messages of individual commits. The auto-merge bot does this by default.

@ghost
Copy link

ghost commented Jun 17, 2021

Thanks Nirmal4G for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌

@ghost ghost requested review from michael-hawker, azchohfi, Kyaa-dost and Rosuavio June 17, 2021 10:22
@Nirmal4G Nirmal4G force-pushed the feature/markdown branch 2 times, most recently from 5adcba4 to 85b32d2 Compare June 17, 2021 13:45
@Nirmal4G Nirmal4G force-pushed the feature/markdown branch 2 times, most recently from 8c4e150 to ddaaa54 Compare June 19, 2021 08:35
@michael-hawker michael-hawker added this to the 7.1 milestone Jun 29, 2021
@Nirmal4G Nirmal4G force-pushed the feature/markdown branch 3 times, most recently from f462359 to f86d6c3 Compare July 22, 2021 19:12
@ghost ghost added the documentation 📃 label Jul 30, 2021
Clean-up and Format with MarkdownLint
Fix-up MarkdownLint warnings
@thiago-cs
Copy link
Contributor

thiago-cs commented Aug 5, 2021 via email

@Nirmal4G
Copy link
Contributor Author

Nirmal4G commented Aug 5, 2021

The new link points to the Features section of the project’s main page, which can also be accessed through CommunityToolkit/WindowsCommunityToolkit#-features-mailbox.

That's the old link. The new link will be CommunityToolkit/WindowsCommunityToolkit#-features- when this PR is merged. Use #supported fragment instead of the link fragment that is shown when you hover over the link anchor.

@Nirmal4G Nirmal4G requested review from michael-hawker and removed request for Kyaa-dost August 5, 2021 11:08
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
CODE_OF_CONDUCT.md Show resolved Hide resolved
Copy link
Member

@michael-hawker michael-hawker left a comment

Choose a reason for hiding this comment

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

Thanks @Nirmal4G! Think there's a way to add the Markdown Linter tool you used to the CI/Pipeline checks like we do with the header and stylecop formatting?

@michael-hawker michael-hawker merged commit c5adae9 into CommunityToolkit:main Aug 12, 2021
@Nirmal4G
Copy link
Contributor Author

@michael-hawker Should be possible, I'm already looking into basic formatting, spelling checks via CI. I'll let you know.

@Nirmal4G Nirmal4G deleted the feature/markdown branch August 13, 2021 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dead link in the PR markdown form Format and Update Markdown files
5 participants