Conversation
Added Documentation for - Writing Updated Documentation for - Reading - Compatible RFID Blanks Cleaned up and reorganized the rest of the documentations.
- Mark backdoor as legacy method - Simplify language - Mention specific Proxmark3 version required - Remove redundant example - Continue to give primary support Flipper Zero - Add link to Bambu Lab RFID library
- Combine sections for identifying and writing - De-duplicate instructions - Remove expected output sections - Simplify language - Convert notes to GFM Noteblock syntax - Use multi-line syntax for command
queengooborg
left a comment
queengooborg
left a comment
There was a problem hiding this comment.
I've pushed a couple of commits that contained the changes I was looking for to further clean up the documentation and remove a few of the parts I thought was out of scope for our documentation.
If it all looks good to you, please let me know and I willmerge this right away; otherwise, if there were any changes that I made that you would like to further discuss, let me know when I would be more than happy to do so!
|
I have reviewed the changes, while I am fine with much of the formatting changes, I prefer the original way of telling of instructions. I think much of the original instructions and cautions were lost to over generalization, while this is fine for users who are familiar and know what they are doing, I have learnt that in the 3D printing community as opposed to the more technical programming community, most of the audience actually don't know what they are doing... so providing a snippet of the expected output verbatim is a good way to let the user know that they are on the right track... it is also how it is done on the proxmark3 repo... also while my instructions may seem drawn out and redundant... it is by design... as people generally don't read and/or skips... so by having a hard separation between tag types... we prevent people from misunderstanding and either miss or input commands not applicable for their tag type... again the expected output example put people at ease as the write once nature of the tags in combination of "noob-ness" already induce enough anxiety and yea... I wrote this down before I finished reviewing all of the commits... but UFUID does not respond well to the restore command and often fails... while the tech savvy community appreciates knowing what commands are being inputted... I had stacked the commands on purpose especially for the sealing process, while nothing will go wrong per se, but sending those commands too slowly will result in it not sealing... dont ask me how I know... anyway... the point I am trying to drive across is... by making the compromise of seemingly redundant and drawn out documentation... it is an attempt to reduce the number of people coming to discord asking for help |
queengooborg
dismissed
their stale review
Some of the most desired changes were reverted, a re-review is needed
2 participants
Added Documentation for
Updated Documentation for
Cleaned up and reorganized the rest of the documentations.