oasisprotocol / oasisprotocol/docs

Extend Celer docs for advanced use cases

Open
#1,004 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15
Forks
46
Avg merge
1d 21h
Merged PRs (30d)
1

Description

Right now our Celer docs only describe the basic use case of sending a message cross-chain.

Do we need own docs for advanced use cases like asset transfer or is referring to the Celer documentation sufficient?

extract from https://github.com/oasisprotocol/docs/issues/929

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 by reviewing the existing Celer documentation in this repository and the referenced issue 929, then compare its basic cross-chain messaging coverage with Celer's advanced-use-case documentation. Done means the project has either dedicated guidance for asset transfers and other advanced cases or a clear, intentional reference to the external Celer documentation.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.