ObolNetwork / ObolNetwork/obol-docs

Create a new Charon architecture image

Open
#95 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
27
Forks
61
Avg merge
1h 22m
Merged PRs (30d)
2

Description

Problem to be Solved

This image is out of date and wrong https://docs.obol.tech/docs/next/charon/intro#charon-architecture

Proposed Solution

Work with Corver and the protocol team to rough sketch a new one. Give to our graphic designer to make it to a super pretty variant.

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 outdated Charon architecture image at the linked documentation page. Coordinate with Corver and the protocol team on a replacement sketch, then pass the agreed design to the graphic designer. Done means the documentation contains the approved, updated architecture image.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.