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: Maintenance - Fix prettier docs script #29693

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Nov 22, 2024

With this pull request, the Docs-related prettier script is updated to run accurately, as the directory it points to is no longer valid since the infrastructure change (i.e., ./snippets).

There's one small item here that I would need some input as probably the mdx related snippets (e.g., https://github.com/storybookjs/storybook/blob/next/docs/_snippets/storybook-auto-docs-baseline-example.md) will probably generate an incorrect import/comment.

@yannbf if you have a moment, can you provide me with some assistance on this? Thanks in advance

Greptile Summary

Updates the prettier scripts in scripts/package.json to correctly target the new _snippets directory path following documentation infrastructure changes.

  • Modified docs:prettier:check script path from ./snippets to ./_snippets in scripts/package.json
  • Modified docs:prettier:write script path from ./snippets to ./_snippets in scripts/package.json
  • Potential issue flagged with MDX snippet imports/comments in files like docs/_snippets/storybook-auto-docs-baseline-example.md

@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 22, 2024
@jonniebigodes jonniebigodes self-assigned this Nov 22, 2024
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Nov 22, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ee86f30. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant