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

docs: fix formatting and punctuation in documentation files #421

Closed
wants to merge 1 commit into from

Conversation

hichemfantar
Copy link

@hichemfantar hichemfantar commented Nov 19, 2024

Description

Improve the clarity and consistency of documentation by correcting formatting and punctuation errors throughout various files.
format docs according to https://github.com/DavidAnson/markdownlint

Related Tickets & Documents

closes #425

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] What gif best describes this PR or how it makes you feel?

@hichemfantar hichemfantar requested a review from a team as a code owner November 19, 2024 13:41
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Issue Reference

In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for saucedocs ready!

Name Link
🔨 Latest commit 4a9aab7
🔍 Latest deploy log https://app.netlify.com/sites/saucedocs/deploys/673c959c94dbd100084f79c2
😎 Deploy Preview https://deploy-preview-421--saucedocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hichemfantar hichemfantar changed the title Fix formatting and punctuation in documentation files docs: fix formatting and punctuation in documentation files Nov 19, 2024
@adiati98
Copy link
Member

Refer to this comment for the reason of PR closing.

@adiati98 adiati98 closed this Nov 25, 2024
@hichemfantar
Copy link
Author

@adiati98 i created and linked the proper issue, feel free to reopen when approved

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.

Feature: follow markdown lint rules
2 participants