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

chore(docs): added eslint to lint documentation code blocks #2920

Merged
merged 8 commits into from
Dec 30, 2022

Conversation

shahednasser
Copy link
Member

  • Use eslint-plugin-markdown to add linting to code blocks in documentation
  • Generally used the same eslint configurations of the core, but turned off some rules that are not necessary for the documentation
  • Added the lint:docs command passing it the necessary configurations
  • Added a new eslint test action for the documentation
  • Made changes across the documentation based on errors from eslint

Closes DOCS-375

@changeset-bot
Copy link

changeset-bot bot commented Dec 30, 2022

⚠️ No Changeset found

Latest commit: 7cbd289

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@shahednasser
Copy link
Member Author

shahednasser commented Dec 30, 2022

@olivermrbl or @srindom can you give this a general review (mainly of the new eslint configurations of the documentation)? No need to review the documentation files.

Copy link
Collaborator

@srindom srindom left a comment

Choose a reason for hiding this comment

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

LGTM - rules look correct to me.

@shahednasser shahednasser merged commit d1b4b11 into master Dec 30, 2022
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.

2 participants