ObolNetwork / ObolNetwork/obol-docs

Update the docs related to the split system/Withdrawal Contribution

Open
#370 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

The existing documentation lacks clear instructions and visuals for the split system or "Withdrawal Contribution". This could confuse users who try to understand and utilize it.

image.png image.png

🛠️ Proposed solution

  • Review the current documentation related to the split system/Withdrawal Contribution
  • Update the documentation with step-by-step instructions on how to use the split system/Withdrawal Contribution feature
  • Include relevant screenshots or visuals to help users better understand the process

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

No file or entry point is named; start by locating the current documentation for the split system or Withdrawal Contribution and review how the feature is described today. Document the process step by step and add relevant screenshots or visuals, then verify that the updated page clearly explains how users use the feature.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.