OpenWPM icon indicating copy to clipboard operation
OpenWPM copied to clipboard

Remove all TODOs from the docs

Open vringar opened this issue 4 years ago • 9 comments

The following things need to be done:

  • [ ] Document the navigation instrument
  • [ ] Document the callstack instrument
  • [ ] Document the DNS instrument
  • [ ] Document how http_redirects works now

vringar avatar Oct 06 '20 14:10 vringar

Anybody who wants to work on one of these things can have that broken out into a separate issue. Though I hope that @englehardt and I will just sit down and write these things out in a session.

vringar avatar Oct 06 '20 14:10 vringar

Hi @vringar i would like to work on this , although i might need some help from the start as this is my first time working on open source .

joy2306 avatar Oct 06 '20 16:10 joy2306

Hey @joy2306, thanks for choosing OpenWPM for your first open source contribution. However I'm afraid that this issue isn't suitable for a beginner. Do you want to have a look at #679 and tell me if that seems interesting to you? Please don't worry about being a beginner, the issue I'm suggesting is quite simple in its implementation and I am willing to help you get familiar with the process.

vringar avatar Oct 06 '20 17:10 vringar

Hey @vringar i saw the issue and couldn't interpret it properly as to what its asking , so if you can just help me out it would have been easier

joy2306 avatar Oct 06 '20 17:10 joy2306

@vringar I would love to work on this alongside #495, I want to understand the platform better. I was also looking into web instrumentation yesterday but could not find any significant resources on it, Do you think this will be a good learning opportunity?

ankushduacodes avatar Nov 26 '20 10:11 ankushduacodes

@vringar just a friendly reminder for this comment 😃

ankushduacodes avatar Dec 02 '20 14:12 ankushduacodes

Go right ahead. I might be a little less available the next couple of weeks as I try to finally get #753 done, so you might be stuck on questions a little while longer, but feel free to explore!

vringar avatar Dec 02 '20 15:12 vringar

Go right ahead. I might be a little less available the next couple of weeks as I try to finally get #753 done, so you might be stuck on questions a little while longer, but feel free to explore!

For sure, could you please give a starting point as to what and where to explore. And if there is some readings to do, I will be happy to do it

ankushduacodes avatar Dec 02 '20 16:12 ankushduacodes

I think the DNS instrument is the best place to start as the other 3 topics are pretty advanced and go deep into firefox. As for reading on the DNS instrument I would suggest reading the source and trying to find the PR it was introduced in to have a look at what we discussed there.

vringar avatar Dec 02 '20 16:12 vringar