I think trying to add comments/docs to each line is to verbose, but some comments are really useful.
Summary: in each file – makes sense – describe what this example does
Documentation: for each example – it's good – link the docs when one can learn more details
Advice: for specific params – it's to verbose – almost everything can be changed, the linked documentation explains more details about the possible values, and we don't want to duplicate big parts of the docs here
Advice: for optional / required sections – it's also verbose, and still doesn't guide an user about what other options they have
Explanation: for a specific resource – makes sense – one sentence info on what it does
Explanation: for specific params – makes sense – it explains an important part of functionality (in short form)
I think trying to add comments/docs to each line is to verbose, but some comments are really useful.
Summary:in each file – makes sense – describe what this example doesDocumentation:for each example – it's good – link the docs when one can learn more detailsAdvice:for specific params – it's to verbose – almost everything can be changed, the linked documentation explains more details about the possible values, and we don't want to duplicate big parts of the docs hereAdvice:for optional / required sections – it's also verbose, and still doesn't guide an user about what other options they haveExplanation:for a specific resource – makes sense – one sentence info on what it doesExplanation:for specific params – makes sense – it explains an important part of functionality (in short form)