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

Updated TypeDoc plugins #940

Merged
merged 3 commits into from
Sep 27, 2023
Merged

Updated TypeDoc plugins #940

merged 3 commits into from
Sep 27, 2023

Conversation

tgreyuk
Copy link
Contributor

@tgreyuk tgreyuk commented Sep 26, 2023

What is does?

This PR updates TypeDoc plugin versions to fix issues:

typedoc2md/typedoc-plugin-markdown#475
typedoc2md/typedoc-plugin-markdown#473
typedoc2md/typedoc-plugin-markdown#470

Changes

  • Updates relevant typedoc plugin versions
  • Updated plugin options
  • Updated sidebar file to pull in manually created typedoc sidebar
  • Updated referenced md files with new file names

@tgreyuk tgreyuk requested review from a team as code owners September 26, 2023 23:02
@socket-security
Copy link

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: @lavamoat/allow-scripts@2.3.1, prettier@3.0.2, typedoc-plugin-frontmatter@0.0.2

@socket-security
Copy link

socket-security bot commented Sep 26, 2023

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: @lavamoat/aa@3.1.5

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

@Montoya
Copy link
Collaborator

Montoya commented Sep 27, 2023

@ziad-saab nice changes here to get the sidebar working.

@ziad-saab
Copy link
Contributor

@SocketSecurity ignore @lavamoat/aa@3.1.5

@ziad-saab
Copy link
Contributor

Previewed locally, looks great! Thank you @tgreyuk for your plugins, and your contributions to our docs 🙏🏼❤️

docusaurus.config.js Outdated Show resolved Hide resolved
@ziad-saab ziad-saab merged commit 6a53d6d into MetaMask:main Sep 27, 2023
11 checks passed
@tgreyuk
Copy link
Contributor Author

tgreyuk commented Sep 28, 2023

Previewed locally, looks great! Thank you @tgreyuk for your plugins, and your contributions to our docs 🙏🏼❤️

No problem. Please do continue raising issues and suggested improvements - its very useful to have real feedback.

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.

4 participants