documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[Enhancement]: Clean up older files and scripts

Open dwightjl opened this issue 3 years ago • 4 comments

What would you like us to improve?

Some scripts and older files are no longer necessary and can be removed.

.eleventy/ networks.ts process-data.ts

Possibly several other files. Clean up and remove these files and others.

How important it is?

Low

dwightjl avatar Feb 06 '23 20:02 dwightjl

Hi @dwightjl,

I'm interested in contributing to the ChainLink Docs repository. I'm a beginner and looking to improve my skills I'm familiar with Solidity, JavaScript, React, and Java. But I'm not sure where to start, though. Do you have any suggestions for specific issues or tasks that would be suitable for someone with my level of experience?

Thanks in advance for your help!

Is this issue is still open ?

Rahul-Prasad-07 avatar Mar 13 '23 06:03 Rahul-Prasad-07

@Rahul-Prasad-07 We cleaned up some files but need to do the same for networks.ts and other scripts. There is still some work to do for this issue. We just need to assess which scripts are no longer necessary.

The majority of our open issues are for Node Operators documentation, which is getting extra attention from us this year. One area where we could use some help is with Data Feeds documentation. We have some basic examples showing how to read data feeds, but it would be nice to have a full tutorial showing how to build a simple application that uses data feeds on-chain. More tutorials for applications using Automation and VRF would be great as well. Getting hands-on experience building with our services is a great way to get more experience with Web3 and smart contracts.

Thank you for helping us out with the documentation! We love external contributions.

dwightjl avatar Mar 23 '23 18:03 dwightjl

Thank you for giving your time to guide me and the update on the ongoing work for the issue.

I appreciate your efforts in improving the project's documentation.

Rahul-Prasad-07 avatar Mar 23 '23 19:03 Rahul-Prasad-07

@Rahul-Prasad-07 We cleaned up some files but need to do the same for networks.ts and other scripts. There is still some work to do for this issue. We just need to assess which scripts are no longer necessary.

The majority of our open issues are for Node Operators documentation, which is getting extra attention from us this year. One area where we could use some help is with Data Feeds documentation. We have some basic examples showing how to read data feeds, but it would be nice to have a full tutorial showing how to build a simple application that uses data feeds on-chain. More tutorials for applications using Automation and VRF would be great as well.

@dwightjl In the Chainlink Fall 2022 hackathon, I worked with Data feeds in one of our project based on Stable coin backed by commodities.

Would you mind if I give it a try?

I can create a comprehensive and easy-to-follow tutorial for using Data Feeds. Thank you!

Rahul-Prasad-07 avatar Mar 23 '23 19:03 Rahul-Prasad-07