iotaledger / iotaledger/identity

[Task] Trim Readme in `identity_iota` to reduce duplication

Open
#1,605 0 comments 0 reactions 0 assignees View on GitHub
Documentation
Dominant language
Rust
Stars
346
Forks
100
Avg merge
13h 41m
Merged PRs (30d)
2

Description

## Description
Currently, the root level README file and the README in `idenity_iota` are duplicated. This is required to have a proper crate documentation in `idenity_iota` AND have a good entry point on GitHub.

We could add an automatic step during crate publishing, that just the root level README into the `identity_iota` folder.

## Motivation
This way we could reduce the `identity_iota` README to a much shorter version and avoid having the README in two places, possibly diverging over time.

Contributor guide

Open the contributing guide

Research direction

Review the root-level README and the README in `idenity_iota`, then inspect the crate-publishing step that could copy the root README into the crate folder. Done means the crate README is shortened without losing its documentation entry point, and publishing keeps the two locations from diverging.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.