Create documentation.md

Author: justinxu421

.github/workflows/format-check.yml

@@ -0,0 +1,14 @@
+---
+description: Generate a structured bug fix approach
+argument-hint: [bug-description]
+model: gpt5
+---
+
+Help me fix this bug: $ARGUMENTS
+
+Please provide:
+
+1. Root cause analysis
+2. Step-by-step fix approach
+3. Testing strategy
+4. Prevention measures for similar issues

examples/commands/commands/bug-fix.md

@@ -0,0 +1,15 @@
+---
+description: Perform a comprehensive code review
+argument-hint: [file-path]
+model: gpt5
+---
+
+Please perform a comprehensive code review of the specified file or current changes, focusing on:
+
+1. Code Quality: Check for readability, maintainability, and adherence to best practices
+2. Security: Look for potential security vulnerabilities
+3. Performance: Identify potential performance issues
+4. Testing: Suggest areas that need test coverage
+5. Documentation: Check if code is properly documented
+
+$ARGUMENTS

examples/commands/commands/code-review.md

@@ -0,0 +1,18 @@
+---
+description: Generate comprehensive documentation
+argument-hint: [file-or-component]
+model: gpt5
+---
+
+Generate documentation for: $ARGUMENTS
+
+Include:
+
+1. Overview and purpose
+2. API reference with parameters and return values
+3. Usage examples with code snippets
+4. Configuration options if applicable
+5. Error handling and troubleshooting
+6. Dependencies and requirements
+
+Format as clear, structured markdown.

examples/commands/commands/documentation.md

@@ -0,0 +1,18 @@
+---
+description: Analyze and optimize code performance
+argument-hint: [file-path]
+model: gpt5
+---
+
+Analyze the performance of: $ARGUMENTS
+
+Please examine:
+
+1. Algorithm complexity and efficiency
+2. Memory usage patterns
+3. Database queries and optimization opportunities
+4. Caching strategies
+5. Network requests and bundling
+6. Rendering performance (for frontend code)
+
+Suggest specific optimizations with expected impact.

examples/commands/commands/performance-optimization.md

@@ -0,0 +1,18 @@
+---
+description: Perform security analysis on code
+argument-hint: [file-path]
+model: gpt5
+---
+
+Perform a security review of: $ARGUMENTS
+
+Focus on:
+
+1. Input validation and sanitization
+2. Authentication and authorization checks
+3. Data exposure and privacy concerns
+4. Injection vulnerabilities (SQL, XSS, etc.)
+5. Cryptographic implementations
+6. Dependencies with known vulnerabilities
+
+Provide specific recommendations for any issues found.

examples/commands/commands/security-review.md

@@ -0,0 +1,18 @@
+---
+description: Generate comprehensive test cases
+argument-hint: [file-or-module]
+model: gpt5
+---
+
+Generate test cases for: $ARGUMENTS
+
+Create tests covering:
+
+1. Happy path scenarios
+2. Edge cases and boundary conditions
+3. Error handling and exceptions
+4. Integration points with other components
+5. Performance considerations
+6. Security edge cases
+
+Use appropriate testing framework conventions and include setup/teardown as needed.

examples/commands/commands/tests.md

@@ -0,0 +1,18 @@
+---
+description: Generate comprehensive documentation
+argument-hint: [file-or-component]
+model: gpt5
+---
+
+Generate documentation for: $ARGUMENTS
+
+Include:
+
+1. Overview and purpose
+2. API reference with parameters and return values
+3. Usage examples with code snippets
+4. Configuration options if applicable
+5. Error handling and troubleshooting
+6. Dependencies and requirements
+
+Format as clear, structured markdown.

examples/commands/documentation.md

@@ -0,0 +1,23 @@
+# Basic PR Description Generation
+# Automatically generates AI-powered descriptions for new pull requests
+
+name: Auto-describe PRs
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  describe:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Generate PR Description
+        uses: augmentcode/describe-pr@v0
+        with:
+          augment_session_auth: ${{ secrets.AUGMENT_SESSION_AUTH }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pull_number: ${{ github.event.pull_request.number }}
+          repo_name: ${{ github.repository }}
+

examples/workflows/workflows/describe-pr.yml

@@ -0,0 +1,49 @@
+# On-Demand PR Description
+# Generates descriptions when the "augment_describe" label is added to a PR
+
+name: On-Demand PR Description
+on:
+  pull_request:
+    types: [labeled]
+
+jobs:
+  describe:
+    # Only run when the specific label is added
+    if: github.event.label.name == 'augment_describe'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Generate PR Description
+        uses: augmentcode/describe-pr@v0
+        with:
+          augment_session_auth: ${{ secrets.AUGMENT_SESSION_AUTH }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pull_number: ${{ github.event.pull_request.number }}
+          repo_name: ${{ github.repository }}
+
+      - name: Remove trigger label
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
+        with:
+          script: |
+            // Remove the trigger label after processing
+            await github.rest.issues.removeLabel({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              name: 'augment_describe'
+            });
+
+      - name: Add completion label
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
+        with:
+          script: |
+            // Add a label to indicate the description was generated
+            await github.rest.issues.addLabels({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              labels: ['auto-described']
+            });
+