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: initial docs for chainhub #1142

Closed
wants to merge 4 commits into from
Closed

Conversation

rabi-siddique
Copy link
Contributor

@rabi-siddique rabi-siddique commented Jul 9, 2024

The PR documents ChainHub API with code examples.

rendered:

refs

@rabi-siddique rabi-siddique marked this pull request as draft July 9, 2024 07:19
Copy link

cloudflare-workers-and-pages bot commented Jul 9, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: f2f4dd7
Status: ✅  Deploy successful!
Preview URL: https://c019d01b.documentation-7tp.pages.dev
Branch Preview URL: https://rs-chainhub-documentation.documentation-7tp.pages.dev

View logs

Copy link

github-actions bot commented Jul 9, 2024

Cloudflare deployment logs are available here

@rabi-siddique rabi-siddique force-pushed the rs-chainhub-documentation branch from d418451 to 071fea6 Compare July 9, 2024 09:50
@rabi-siddique rabi-siddique marked this pull request as ready for review July 9, 2024 11:01
@rabi-siddique rabi-siddique requested a review from dckc July 9, 2024 14:46
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved
main/guides/orchestration/chainhub.md Outdated Show resolved Hide resolved

The core functionality is encapsulated within the `makeChainHub` function, which sets up a new `ChainHub` in the given zone. The `ChainHub` is responsible for:

## **chainHub.registerChain(name, chainInfo)**
Copy link
Contributor

Choose a reason for hiding this comment

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

Either remove chainHub in all APIs or add to all of them.
I think for cleaner presentation you may just delete chainHub in all.

Also, because this is a heading, you may also delete the parameters. But I haven't seen at other pages to confirm what is the convention here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding chainHub with all APIs. Followed conventions from here

@rabi-siddique rabi-siddique force-pushed the rs-chainhub-documentation branch from 6abeb9c to d8056fe Compare July 10, 2024 04:07
@rabi-siddique rabi-siddique requested a review from toliaqat July 10, 2024 04:36
@rabi-siddique rabi-siddique force-pushed the rs-chainhub-documentation branch from d8056fe to f2f4dd7 Compare July 10, 2024 04:57
Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

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

This looks like reference docs.

Let's please get it in @agoric/orchestration reference docs instead, please.

@toliaqat toliaqat closed this Aug 12, 2024
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