Contributing to Gobi with Model Context Protocol (MCP)

name: Documentation Check

on:
  pull_request:
    types: [opened, synchronize]
    paths:
      - 'core/**'
      - 'extensions/**'
      - 'packages/**'
      - 'gui/**'

jobs:
  check-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install Gobi CLI
        run: npm i -g @gourmanddev/cli

      - name: Analyze Changes for Documentation Needs
        id: analyze
        env:
          GOBI_API_KEY: ${{ secrets.GOBI_API_KEY }}
        run: |
          echo "🔍 Analyzing code changes for documentation needs..."

          # Get changed files
          git diff origin/${{ github.base_ref }}..HEAD --name-only > changed_files.txt

          # Create detailed diff
          git diff origin/${{ github.base_ref }}..HEAD > changes.diff

          # Use Gobi agent to check if docs need updates
          PROMPT="Review these code changes and determine if documentation updates are needed.

          Changed files: $(cat changed_files.txt | tr '\n' ' ')

          Consider:
          - New features or APIs
          - Breaking changes
          - New configuration options
          - Modified CLI commands
          - New MCP integrations

          If docs updates are needed, specify which files in docs/ should be updated.
          If no updates needed, respond with 'NO_DOCS_NEEDED'.
          Be specific and concise."

          cn --config gourmand/docs-mintlify -p "$PROMPT" --auto > analysis.md || {
            echo "⚠️ Analysis failed"
            echo "needs_docs=false" >> $GITHUB_OUTPUT
            exit 0
          }

          if grep -q "NO_DOCS_NEEDED" analysis.md; then
            echo "needs_docs=false" >> $GITHUB_OUTPUT
          else
            echo "needs_docs=true" >> $GITHUB_OUTPUT
          fi

      - name: Post Documentation Recommendation
        if: steps.analyze.outputs.needs_docs == 'true'
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          echo "📝 Creating PR comment with documentation recommendations..."

          cat > pr-comment.md <<'EOF'
## 📚 Documentation Update Recommended

Based on the code changes in this PR, documentation updates may be needed:

EOF

          cat analysis.md >> pr-comment.md

          cat >> pr-comment.md <<'EOF'

---

### Next Steps

1. Review the suggested documentation areas above
2. Update relevant files in the `/docs` folder
3. Consider updating:
   - API references for interface changes
   - Guides for workflow changes
   - Configuration docs for new settings
   - MCP cookbooks for new integrations

### Resources
- [Contributing to Docs](/CONTRIBUTING)
- [Gobi Docs MCP Cookbook](/guides/gobi-docs-mcp-cookbook)

*This analysis was generated using the Gobi Docs MCP agent.*
EOF

          gh pr comment ${{ github.event.pull_request.number }} --body-file pr-comment.md

      - name: Add Label
        if: steps.analyze.outputs.needs_docs == 'true'
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          gh pr edit ${{ github.event.pull_request.number }} --add-label "docs-needed"