MetaMask / MetaMask/metamask-docs

Embedded Wallets: standardize parameter presentation

Open
#2,648 1 comment 0 reactions 0 assignees View on GitHub
embedded wallets
Dominant language
MDX
Stars
861
Forks
2.1k
Avg merge
6d 10h
Merged PRs (30d)
10

Description

Standardize presentation of parameters across:
- optional vs required items, this is sometimes handled with ? at end of parameter --> Discussed with @yashovardhan
> Decision is for ? for optional and then (Required) at the start of the description for the not-optional
- add column to tables to support type
> For booleans, this will then allow Default: none | Default: `true` (or t or 1, per the config) | Default: false (or f or 0, per the config) at the start of the description
- true and false as `true` and `false`

Contributor guide

Open the contributing guide

Research direction

Start with the embedded wallet documentation and locate the parameter tables covered by this issue. Apply the stated conventions for optional and required parameters, type columns, boolean defaults, and true/false formatting; done means the relevant tables use the same presentation throughout.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.