Skip to content

Initial Multichain API docs #1621

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

Open
wants to merge 42 commits into
base: main
Choose a base branch
from
Open

Initial Multichain API docs #1621

wants to merge 42 commits into from

Conversation

alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Oct 9, 2024

Description

Initial Multichain API docs.

Issue(s) fixed

Fixes #1566

Preview

(Links updated May 1)

Checklist

Complete this checklist before merging your PR:

  • If this PR contains a major change to the documentation content, I have added an entry to the top of the "What's new?" page.
  • The proposed changes have been reviewed and approved by a member of the documentation team.

Copy link

vercel bot commented Oct 9, 2024

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 May 1, 2025 6:34pm

@vandan
Copy link
Contributor

vandan commented Oct 18, 2024

For MetaMask, I do not believe we need to document the scenario where wallet_createSession is used with sessionIds.

# Conflicts:
#	docusaurus.config.js
#	wallet-sidebar.js
…nto 1566-multichain

# Conflicts:
#	docusaurus.config.js
#	wallet-sidebar.js
@alexandratran alexandratran self-assigned this Nov 4, 2024
Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some initial feedback.

# About the Multichain API

:::tip Experimental
The Multichain API is an experimental feature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we say "early access feature" instead? Experimental probably won't give the user as much confidence to use the feature. @vandan, do you have a preference?

@@ -177,6 +182,11 @@ const sidebar = {
label: "About the Wallet API",
id: "concepts/wallet-api"
},
{
type: "doc",
label: "About the Multichain API",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps just "Multichain API"?
Same for the Wallet API above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using "About the <X> API" helps immediately differentiate the explainer page from the API reference. I could see it being confusing for users/search engines/llms if both pages have the same title?

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.

Initial Multichain API docs
6 participants