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.

Sign up for GitHub

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

Jump to bottom

docs: update provider docs #1978

Merged
merged 29 commits into from
Apr 15, 2024
Merged

docs: update provider docs #1978

merged 29 commits into from
Apr 15, 2024

Conversation

nedsalk
Copy link
Contributor

@nedsalk nedsalk commented Mar 30, 2024 •
edited
Loading

closes #1918
closes #975

@nedsalk nedsalk added the docs Requests pertinent to documentation label Mar 30, 2024
@nedsalk nedsalk self-assigned this Mar 30, 2024
@nedsalk nedsalk marked this pull request as ready for review March 30, 2024 13:00
petertonysmith94
petertonysmith94 reviewed Apr 1, 2024
View reviewed changes
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

Small nits

apps/docs/src/guide/provider/index.md Outdated Show resolved Hide resolved
apps/docs/src/guide/provider/index.md Outdated Show resolved Hide resolved
apps/docs/src/guide/provider/index.md Outdated Show resolved Hide resolved
@nedsalk nedsalk requested a review from maschad as a code owner April 4, 2024 06:13
@Dhaiwat10
Copy link
Member

Thoughts on moving this page to the 'Basics' section?

danielbate
danielbate reviewed Apr 4, 2024
View reviewed changes
Copy link
Contributor

@danielbate danielbate left a comment

Choose a reason for hiding this comment

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

@Dhaiwat10 agreed provider is a basic concept, but we should split out the options into a separate page.And add some more snippets to the provider index page on operations it performs.

apps/docs/src/guide/provider/index.md Outdated Show resolved Hide resolved
@nedsalk
Copy link
Contributor Author

nedsalk commented Apr 14, 2024

@Dhaiwat10 @danielbate I moved it to the Basics section and put Provider Options into a separate page. Because there already was a Querying the Chain page, I just referenced it at the end of provider/index.md instead of writing multiple examples. I did update the single example to showcase how a Provider is used in conjunction with a wallet, though.

@nedsalk nedsalk enabled auto-merge (squash) April 15, 2024 13:50
petertonysmith94
petertonysmith94 reviewed Apr 15, 2024
View reviewed changes
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

These are my final comments.

apps/docs-snippets/src/guide/provider/querying-the-chain.test.ts Show resolved Hide resolved
apps/docs-snippets/src/guide/provider/querying-the-chain.test.ts Show resolved Hide resolved
apps/docs-snippets/src/guide/provider/querying-the-chain.test.ts Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
79.38%(+0%) 69.67%(+0%) 77.33%(+0%) 79.53%(+0%)
Changed Files:

Coverage values did not change👌.

@nedsalk nedsalk merged commit dc2911e into master Apr 15, 2024
15 checks passed
@nedsalk nedsalk deleted the ns/docs/provider branch April 15, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petertonysmith94 petertonysmith94 petertonysmith94 approved these changes

@arboleya arboleya arboleya approved these changes

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

@danielbate danielbate Awaiting requested review from danielbate danielbate is a code owner

@maschad maschad Awaiting requested review from maschad maschad is a code owner

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10 Dhaiwat10 is a code owner

Assignees

@nedsalk nedsalk

Labels
docs Requests pertinent to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Provider Add docs around different capabilities of a Provider instance
7 participants
@nedsalk @Dhaiwat10 @arboleya @danielbate @maschad @petertonysmith94 @Torres-ssf