paritytech / paritytech/dotns

[Feat]: High level doc refinement

Open
#36 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: docs
Dominant language
Solidity
Stars
4
Forks
2
Avg merge
1d 18h
Merged PRs (30d)
24

Description

Component

Other

Summary

Inspired from this comment

On a more general note not related to this PR: if this repository had more information on why it made the decisions it did eg explaining the purpose of splitting the contracts how they are, why the flows are the way they are etc, it would be helpful personally (for me, but also for things like Claude to be more helpful in checking things I expect)

We should aim to clean up and refine some high level documentation. Start very general and then add specificity as needed. Be concise as well

  • What is DotNS
  • Why do we want DotNS / motivation for DotNS
  • What are the key pieces and contracts of DotNS
  • What do they do and why do they do it

Assume someone is coming in with 0 context or expertise, could they get a solid high level understanding and know where to start if they want to contribute in under 1 hour.

Proposal

No response

Acceptance criteria

No response

Context / notes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the repository's existing documentation and the high-level structure of its DotNS contracts, then use the linked review comment as context for the missing explanations. Done means concise documentation that explains what DotNS is, its motivation, the key contracts and flows, why they are structured that way, and where a newcomer should begin contributing.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.