-
Notifications
You must be signed in to change notification settings - Fork 5
[Docs] Start adding documentation as script headers #157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Conversation
…pts if it's not possible to make an original bash script compatible with Windows
Generated by 🚫 Danger |
👋 @AliSoftware, long overdue but could we maybe close, or remove |
I've removed the team as reviewer, but honestly I think we could as well merge those docs even if they are not perfect, and iterate later if we find errors or refinements to make on those at some point, but at least we'd have a starting point? |
Sure, I agree, it is just that the PR is draft I guess, thus no-one is reviewing it (I think)... 🤷 |
I guess nobody is reading PR descriptions, those days 😇
But fair enough, I think that was probably one of the reasons indeed. I'll maybe try to find some time to make a quick human pass at it then switch to ready for review at some point. |
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.