argumentcomputer / argumentcomputer/Ipld.lean

Documentation

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Lean
Stars
8
Forks
1
PR merge metrics
No merged PRs in 30d

Description

# Why

The repo is meant to provide an API for IPLD but it's currently undocumented, which makes its use harder (and maybe error prone)

# How

- [ ] Add docstrings to declarations
- [ ] Check the possibility of using [`doc-gen4`](https://github.com/leanprover/doc-gen4) to create a pretty documentation page

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the repository's declarations to identify the public IPLD API that needs docstrings. Then investigate whether doc-gen4 can generate the requested documentation page; the work is done when the declarations are documented and the feasibility or resulting documentation page is recorded.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.