smartcontractkit / smartcontractkit/documentation
[Enhancement]: Infographic to understand the Chainlink Node architecture
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 526
- Forks
- 478
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 75
Description
What would you like us to improve?
https://docs.linkpool.io/docs/general_chainlink_guide
Recommend we use something like the infographic in the above link for our CL Node related documents, and x-link to it in our docs regarding jobs, external adapters etc. It would offer an excellent overview and ready reference to see the flow of operations and the architecture.
There are some small bits in the language that need to be disambiguated, and I can assist with that when we are putting this together.
How important it is?
The tool would dramatically improve the comprehensibility of our docs and give users a snapshot view, rather than requiring them to pore over the docs and piece together the components.
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
The issue names no files or tests; start by reviewing the linked general Chainlink guide and the current documentation for jobs and external adapters. Clarify the infographic’s architecture and operations scope, resolve the noted terminology ambiguities with the reporter, and link the finished reference from the relevant documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100