-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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: Clarify how to enable math equations #10894
Conversation
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
website/docs/guides/markdown-features/markdown-features-math-equations.mdx
Show resolved
Hide resolved
Thank you for pointing out what the cause of the CI failure was, and fixing it yourself! I didn't understand from the CI logs what it was that prettier was complaining about 😅 Would be possible to make the output a bit more verbose so the actual issues are clearer? Also, it seems like the CI attempted an autofix for the linter issue, but it failed due to lack of permissions to push to my fork. However, I did have the "Allow edits and access to secrets by maintainers" checkbox ticked (it seems to be unticked now, but I am 100% sure it was before, because I checked it when I saw that CI error). Could it be that the action requires additional permissions so it can act as a maintainer and thus be able to autofix linter issues in external PRs like this? |
This is super annoying but Prettier doesn't provide any solution 😅 prettier/prettier#6885 We may need to create it ourself with some kind of git diff output The autofix thing only works for internal PRs. Unfortunately I can't make it work for external PRs in a secure way that easily, and it may involve someone from Meta approving an app. |
😮
Yeah, a git diff would work well IMO. If the log output supports ANSI color escape codes, something like delta would be even better :) |
Pre-flight checklist
Motivation
Typically installation instructions come before usage instructions. The fact that usage section is placed at the top is justified as this may serve as a quick reference to those who have already used the feature before, but a quick note linking to the installation/configuration section will help those who are reading about this for the first time follow the steps in the proper order. This PR adds such a note in a nonintrusive way that doesn't affect the flow of the existing text.
Test Plan
Test links
Deploy preview: https://deploy-preview-10894--docusaurus-2.netlify.app/docs/markdown-features/math-equations