[Docs] Start adding documentation as script headers #157
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warning
.cursor/rules/*.mdc
about how we should document our shell scripts.I have quickly skimmed the generated documentation and changes it made (mostly improvements on finer-grained error handling), but this definitively needs a deeper review and closer look at the changes from a human.
WIP
This is WIP as I've stopped the process after Cursor have updated a good set of initial group of scripts, so that it wouldn't become too much of a time sink on my day.
Even if I'm keeping it as Draft until it's properly reviewed, I've still added the team as reviewer of this PR already, so that we can start have some humans taking a deeper look at the changes it generated.
We could continue asking Cursor to work on the remaining script in a follow-up iteration.