Skip to content
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

[Docs] Start adding documentation as script headers #157

Draft
wants to merge 9 commits into
base: trunk
Choose a base branch
from

Conversation

AliSoftware
Copy link
Contributor

@AliSoftware AliSoftware commented Feb 20, 2025

Warning

⚠️ The content of this PR is entirely generated by Cursor—based on the rules and guidance provided by .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.

  • Let Cursor generate initial documentation (part 1)
  • Let Cursor generate doc for Android helper scripts
  • Cursor Doc for install_npm_packages

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.

image image

@dangermattic
Copy link

2 Warnings
⚠️ Please add an entry in the CHANGELOG.md file to describe the changes made by this PR
⚠️ This PR is larger than 500 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
1 Message
📖 This PR is still a Draft: some checks will be skipped.

Generated by 🚫 Danger

@AliSoftware AliSoftware requested a review from a team February 20, 2025 16:47
Base automatically changed from cursor-rules-powershell to trunk February 20, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants