MetaMask / metamask-docs

Developer documentation for MetaMask
https://docs.metamask.io
Apache License 2.0
632 stars 905 forks source link

feat: ACT-1359 - Add Interactive Params Table #1360

Closed aednikanov closed 1 week ago

aednikanov commented 2 weeks ago

Description

Add an interactive params table and handle simple types.

Screenshot

Screenshot 2024-06-21 at 11 03 16
vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2024 6:23am
socket-security[bot] commented 1 week ago

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

Package New capabilities Transitives Size Publisher
npm/@apidevtools/json-schema-ref-parser@11.6.4 filesystem, network Transitive: environment +4 1.05 MB philsturgeon
npm/react-tippy@1.4.0 None +1 1.94 MB ursa

View full report↗︎

socket-security[bot] commented 1 week ago

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
Deprecated npm/popper.js@1.16.1
  • Reason: You can find the new Popper v2 at @popperjs/core, this package is dedicated to the legacy v1
🚫
Network access npm/@apidevtools/json-schema-ref-parser@11.6.4 🚫

View full report↗︎

Next steps

What is a deprecated package?

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Research the state of the package and determine if there are non-deprecated versions that can be used, or if it should be replaced with a new, supported solution.

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

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 ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore npm/popper.js@1.16.1
  • @SocketSecurity ignore npm/@apidevtools/json-schema-ref-parser@11.6.4
aednikanov commented 1 week ago

@alexandratran it's implementation just like in the design: https://www.figma.com/design/gBbfVUyOdjS5OYZcg9mbUX/Sandbox-%2F-Interactive-API?node-id=492-21938&t=T8XsKFHK3b2e75ld-0

  1. It's the approved design. You could tag Katie and leave your proposal if you want. It's nice to collect feedback from different people with their views and suggestions. And then we will have a better version! But in this case, I think we should go forward, and don't stop on small things. It could be fixed quickly then if needed. Thanks.

  2. Good catch! It was working on localhost but for some reason, the priorities of styles for the error table header were not the same after deployment. I reorganized little few styles, and now it works in both cases.

Also, could you, please, take a look at these alerts? What could we do to pass or ignore them? I need [json-schema-ref-parser@11.6.4](https://socket.dev/npm/package/@apidevtools/json-schema-ref-parser/overview/11.6.4) for sure, it's the main tool for working with the JSON schema.

https://github.com/MetaMask/metamask-docs/pull/1360/checks?check_run_id=26636839795

aednikanov commented 1 week ago

@alexandratran thanks!