Docs Improvement: Making permissions easier
@ziad-saab is already working on this.
Since Jun 8, 2023.
- Dominant language
- TypeScript
- Stars
- 853
- Forks
- 662
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 8
Description
## Description
The same way the Chrome Docs specify which permissions are required to use each API, I think this would make a nice improvement to the Metamask Snaps docs.
The reason I'm suggesting this is because it isn't mentioned anywhere in the Snaps Docs that `snap_manageState` is the key name for using the manage state API.
**Suggestion 1:** It would be nice if all available permission keys were documented on the Permissions page of the Docs. https://docs.metamask.io/snaps/reference/permissions/
**Suggestion 2:** The other way to improve this flow significantly for developers would be to show the required permission key on each API reference page. I've attached an example below of how Chrome does this for extensions.
Example
For `chrome.alarms` it tells you right on the page what key is necessary to enable it.
https://developer.chrome.com/docs/extensions/reference/alarms/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.