FilOzone / FilOzone/filecoin-pay

Documentation for auction: user guide and operational bounds

Open
#286 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Solidity
Stars
8
Forks
13
PR merge metrics
No merged PRs in 30d

Description

## Context
Separated from #253 to track documentation work independently from the audit.

## Done Criteria
1. There is user documentation in the readme (e.g., how do parties participate?)
2. There is operational documentation helping developers understand the bounds of the system (e.g., what is the worst that can happen, how do we ensure there are auction participants, what happens if none shows up).

## Why Important
Users and operators need clear guidance on how the auction works, how to participate, and what edge cases to expect

## Notes
- The audit work is tracked separately in #253.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README and the auction implementation, tracing how parties participate and what happens when no participant appears. Document user participation, operational bounds, worst-case outcomes, and no-participant behavior; done means the README covers both the user guide and developer-facing edge cases described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.