livepeer / livepeer/clearinghouse

Publish API Reference + integration docs to docs.livepeer.org

Open
#16 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Go
Stars
1
Forks
3
Avg merge
1h 47m
Merged PRs (30d)
3

Description

Summary

Publish payment-component documentation (coordinate with Adam): signer standalone usage, clearinghouse suite integration, and an app-integrator decision guide, plus a public API Reference Guide.

Acceptance

  • API Reference Guide publicly available.
  • Docs live on docs.livepeer.org (or staging) and reviewed by at least one core team member.

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 payment-component documentation scope in the issue: signer standalone usage, clearinghouse suite integration, the app-integrator decision guide, and the API Reference Guide. Confirm the publishing path for docs.livepeer.org or staging and coordinate with Adam before drafting. Done means the API Reference and integration materials are publicly available and reviewed by at least one core team member.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.