n0-computer / n0-computer/iroh-docs
Document keyspace overwrite behavior & prefix deletion
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 74
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
We really need to have docs somewhere about the fact that new entries make all other entries obsolete which have the new entry's key as a prefix of their key.
It's uncommon and confusing at first so this needs to be docmented prominently.
See also #55
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing issue #55 and searching the repository for existing keyspace or prefix-deletion documentation. Add a prominent explanation of how a new entry makes entries whose keys have the new key as a prefix obsolete, and confirm the behavior is clearly documented where users will find it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100