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

(docs): Remove makeLocalAccount #1208

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ivanlei
Copy link
Contributor

@ivanlei ivanlei commented Sep 18, 2024

Per Agoric/agoric-sdk#10106 the method orchestrator.makeLocalAccount will be removed.

This PR removes docs about that method. There are no other instances of this method in the docs repo.

Copy link

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7d38f69
Status: ✅  Deploy successful!
Preview URL: https://2f4a53e1.documentation-7tp.pages.dev
Branch Preview URL: https://ivan-10106-remove-makelocala.documentation-7tp.pages.dev

View logs

Copy link

Cloudflare deployment logs are available here

@@ -16,14 +16,6 @@ Retrieves the chain information and provides access to chain-specific methods. S
const chain = await orchestrator.getChain('chainName')
```

### makeLocalAccount
Copy link
Member

Choose a reason for hiding this comment

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

This is accurate but I suspect not complete. If this repo is about a guide to using the API, shouldn't we also indicate how to make a local account? (getChain('agoric')

If this is just a presentation of the API, why is it defined manually here? We can generate API docs from the API repo.

Copy link
Member

@0xpatrickdev 0xpatrickdev left a comment

Choose a reason for hiding this comment

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

Agree Chain object documentation is missing from this page, but this is an improvement since makeLocalAccount guides the developer down the wrong path.

yarn format should make the Lint Markdown job pass

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.

3 participants