smartcontractkit / smartcontractkit/chainlink-starknet
Move Gauntlet docs to main docs dir
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 60
- Forks
- 31
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 2
Description
All relevant docs should go to the ./docs subfolder, and only a quick overview + pointer to docs should be kept in the README.md files.
Imagine we build a CI pipeline that auto-publishes chainlink-starknet/docs to docs.chain.link/starknet - that's the idea, so we want structured docs in a single place.
Originally posted by @krebernisak in https://github.com/smartcontractkit/chainlink-starknet/pull/2#discussion_r876227944
Contributor guide
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 inventorying the repository's README.md files and existing documentation, then compare them with the intended ./docs layout. Move relevant documentation into ./docs while leaving each README with only a brief overview and pointer to the docs; done means the documentation is centralized and the README files are concise.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100