paritytech / paritytech/subxt

Add usage examples to the guide

Open
#920 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
489
Forks
293
Avg merge
18h 35m
Merged PRs (30d)
3

Description

This is a follow-up to #898, because I wanted to break the work down a little.

Add something a bit like this to the end of the main page of the guide:

## Advanced

Follow links from the below sections for information on some more advanced use cases:

- Building a WASM app with Subxt.
- Ditching the statically generated interface.
- Integrating with Substrate.
- Working offline.
- Interacting with a parachain

(actual use cases we want to show need to be thought through)

And then add the corresponding sections and examples etc as needed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the main page of the guide and review the advanced use cases listed in the issue, along with the follow-up context from #898. Decide which scenarios belong in the guide, then add the corresponding sections and examples; done means the guide includes a useful advanced section with examples for the selected use cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, wasm
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.