Skip to content

Add readme file in every folder in src to refer to the detailed documentation in doc #253

@SimonRastikian

Description

@SimonRastikian

Background

Currently the documentation is in a separate folder than src/ which can be difficult to navigate through the src and the docs at the same time.
The idea is to make in each of the important src subfolders, a Readme file that points to the different important documentation. For example, in src/ecdsa/ot_based_ecdsa, create a Readme.md pointing to DKG, ecdsa preliminaries and the multiple different ot based ecdsa documentations.

User Story

No response

Acceptance Criteria

Each important folder contains a Readme pointing to the detailed documentation.
Agree with the peer teammates on whether we do not over/under do it.

Resources & Additional Notes

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions