Skip to content
bitcoinsv.design

Search the guide

Search the guide

Many hands of different skin tones reach in from the edges of the frame, each placing a small pastel paper shape (a square, a circle, a strip) onto a shared white page in the centre, together forming one tidy layout

Contribute

How to correct, review, illustrate or add to this guide, and where the open work is.

This guide is published by the BSV Association and written in the open. If you design, research or build BSV products, you can correct it, illustrate it, or add what you learned shipping one.

Where the work is

Every page is written for BSV. The open work is the artwork that is specified but not yet drawn, the case studies nobody has written, and the corrections only somebody shipping a product would catch.

Four ways in

Correct a page. Find a claim that is not true on BSV, a rule that stopped being true, a diagram that contradicts the text, or an example that would mislead somebody shipping a product. Fix it, or name the page and the sentence. Either is enough.

Review a . Read somebody else's pull request and check its claims. It is the quickest way to learn the guide. See Review.

Draw an image. Over a hundred images are specified and not yet made, most of them in the reference designs and How it works. Each placeholder carries its full prompt, so the brief is already written.

Write up what you shipped. If you have built a BSV wallet or app, the parts that were hard are what this guide is missing. See Case studies.

How to do it

  1. Review is how changes get checked, and the easiest place to start.
  2. Propose a change covers the mechanics.
  3. Content guidelines covers how the guide is written.
  4. Formatting is the reference for the page syntax.
  5. Illustration guidelines covers the artwork.
  6. Case studies covers writing up a product.

How we work

Every page states what it was written from. That makes it correctable: a claim with a source attached can be checked and argued with.

Changes are proposed and reviewed in the open. Disagreement about design is expected and useful. Advocacy is not: the guide documents one system and leaves campaigning to other venues. See the end of Content guidelines.

The source lives on GitHub. Until the repository is public, access is on request. Ask through the enquiry form and say what you want to work on.

Related

Written from: DESIGN.md.