life-itself / life-itself/web3
Rework root README.md now that site is launched
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 213
- PR merge metrics
- No merged PRs in 30d
Description
README.md at root of repo is what people currently see arriving here. We should probably revise it given that a) we now have the main site b) it is now the contribute path for devs
Suggest:
* Move current README content into e.g. notes as `awesome-crypto-critique` or similar (easiest)
* Someday we can move all the library items into the library and then build the page off that but until then ... this is KISS
* Revise README with brief intro to project and instructions for devs and others (and perhaps a pointer to old awesome-cryto-critique content for people who arrive at github repo looking for that - we still have quite a few links on twitter etc to it)
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 with the root README.md and review its current content against the launched main site and the developer contribution path. Decide how the existing content should be preserved under a notes-style destination, then revise the README with a project introduction, contributor guidance, and a pointer to the preserved content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100