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.

Sign up for GitHub

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

Jump to bottom

Chore: Improve TypeScript, Linting, and Styling Support in Doc MDX Files #1588

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Chore: Improve TypeScript, Linting, and Styling Support in Doc MDX Files #1588

wants to merge 2 commits into from

Conversation

moathabuhamad-cengage
Copy link
Collaborator

Issue: #1553

What I did

  • Updated ESLint configuration .eslintrc.js to include @typescript-eslint/parser and mdx plugins.
  • Added rules to handle MDX files and TypeScript.
  • Disabled specific rules for MDX files to avoid unnecessary warnings.
  • Added lint, lint:fix, and lint:check scripts for consistent linting.
  • Updated format script to include more file type

Screenshots:

Screenshot from 2024-11-22 15-03-38

Checklist

  • changeset has been added
  • Pull request description is descriptive
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes
  • [-] I have added tests that prove my fix is effective or that my feature works

How to test

  • Run linting and formatting scripts
  • Ensure MDX files are properly linted and formatted.
  • Check for any linting or formatting errors.

@moathabuhamad-cengage moathabuhamad-cengage added chore Misc. task to complete do not merge Pull requests that should not be merged labels Nov 22, 2024
@moathabuhamad-cengage moathabuhamad-cengage self-assigned this Nov 22, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 22, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 5b998c5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
react-magma-docs Patch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://docs-preview-1588--upbeat-sinoussi-f675aa.netlify.app

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://storybook-preview-1588--upbeat-sinoussi-f675aa.netlify.app

silvalaura
silvalaura reviewed Nov 22, 2024
View reviewed changes
Copy link
Collaborator

@silvalaura silvalaura left a comment

Choose a reason for hiding this comment

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

Haven't had a chance to navigate through every single page, but code wise this looks good!

website/react-magma-docs/src/pages/api/alert.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/card.mdx Show resolved Hide resolved
website/react-magma-docs/src/pages/api/combobox.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://docs-preview-1588--upbeat-sinoussi-f675aa.netlify.app

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://storybook-preview-1588--upbeat-sinoussi-f675aa.netlify.app

silvalaura
silvalaura requested changes Nov 26, 2024
View reviewed changes
website/react-magma-docs/src/pages/api-intro/styles-and-themes.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/appbar.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/buttongroup.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/character-counter.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/dropzone.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/grid.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/icon.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/spacer.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/tooltip.mdx Outdated Show resolved Hide resolved
website/react-magma-docs/src/pages/api/transition.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://docs-preview-1588--upbeat-sinoussi-f675aa.netlify.app

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://storybook-preview-1588--upbeat-sinoussi-f675aa.netlify.app

silvalaura
silvalaura approved these changes Nov 27, 2024
View reviewed changes
Copy link
Collaborator

@silvalaura silvalaura left a comment

Choose a reason for hiding this comment

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

🌟

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@silvalaura silvalaura silvalaura approved these changes

Assignees

@moathabuhamad-cengage moathabuhamad-cengage

Labels
chore Misc. task to complete do not merge Pull requests that should not be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@moathabuhamad-cengage @silvalaura