gnosis / gnosis/conditional-tokens-docs

AMM, CT Framework Searchable Index

Open
#23 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement P2
Dominant language
JavaScript
Stars
7
Forks
7
PR merge metrics
No merged PRs in 30d

Description

The current documentation goes to great lengths to describe what is happening when the CT framework is used. However, it takes a bit of reading. Feedback from Gnosis Dev's points to a preference to having a concise, technical description of each function which is searchable.

I'm not sure exactly where to insert this in the current format of the dev docs and this will most likely require discussion. But a simple list of functions, their parameters, expected return values and examples I believe would be preferable for developers developing with CT framework and AMM.

Reference:
https://docs.python.org/3.4/library/string.html

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the current developer documentation for the CT framework and AMM, then compare its structure with the linked Python documentation reference. First clarify where the searchable function index belongs and which functions need coverage; done means a concise reference lists each function's parameters, return values, and examples.

Written by the indexing model from the issue text.

Assessment

Domain
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.