Documentation
SEO Assist

Code Changes & GitHub Integration

Connect your GitHub repositories and receive AI-generated SEO improvement suggestions with automatic pull request creation.

Pro Feature

GitHub integration requires a Pro or Agency subscription. Connect repositories to get AI-powered code suggestions for SEO improvements.

Overview

The Code Changes feature analyzes your website's source code and generates specific SEO improvement suggestions. Changes can be reviewed with side-by-side diffs and automatically submitted as pull requests to your GitHub repository.

Connecting GitHub

1

Navigate to Integrations

In SEO Assist, go to the Integrations tab and find the GitHub section.

2

Authorize GitHub

Click "Connect GitHub" to start the OAuth flow. You'll be redirected to GitHub to authorize ARKA AI to access your repositories.

3

Select Repositories

Choose which repositories to connect. You can grant access to specific repositories or all repositories in your account/organization.

4

Confirm Connection

After authorization, you'll see your connected repositories listed in the Integrations tab. Each repository shows its default branch and last update timestamp.

SEO File Detection

SEO Assist automatically scans your repository for files that affect SEO:

  • HTML Templates: Files containing <head> sections, meta tags, and semantic markup
  • Meta Tag Files: Components or configs that define titles, descriptions, and Open Graph tags
  • Schema Markup: JSON-LD structured data files and components
  • Content Files: Markdown, MDX, or content configuration files
  • Config Files: next.config.js, nuxt.config.ts, and similar framework configurations

Suggestion Types

The AI generates several types of code suggestions:

TypeDescriptionExample
Meta TagsTitle, description, viewport, charset improvementsAdd missing meta description
Open GraphSocial sharing optimizationAdd og:image for better link previews
Schema MarkupStructured data additionsAdd Article or Product schema
Semantic HTMLProper heading hierarchy, landmarksConvert div to main element
PerformanceLoading optimizationsAdd loading='lazy' to images
AccessibilitySEO-related a11y improvementsAdd alt text to images

Reviewing Suggestions

Each suggestion appears in the Code Changes tab with full context:

Diff View

See exactly what will change with a side-by-side diff showing the original code and suggested modification:

Example: Meta Description Additiondiff
- <head>
-   <title>My Website</title>
- </head>
+ <head>
+   <title>My Website</title>
+   <meta name="description" content="Discover our products and services..." />
+ </head>

Suggestion Workflow

Each suggestion has a status that tracks its progress:

  • Pending: New suggestion awaiting review
  • Approved: Marked for inclusion in a pull request
  • Rejected: Dismissed as not applicable
  • Applied: Included in a created pull request

Editing Suggestions

You can modify any suggestion before approving it. Click the Edit button to adjust the suggested code while keeping the original context. This is useful for:

  • Customizing auto-generated meta descriptions
  • Adjusting schema markup to match your data structure
  • Fine-tuning suggestions to match your coding standards

Creating Pull Requests

1

Review and Approve Suggestions

Go through each suggestion, review the diff, and click Approve for changes you want to include. Reject suggestions that don't apply.

2

Click Create PR

Once you have at least one approved suggestion, click "Create Pull Request" to bundle them into a single PR.

3

Configure PR Details

Enter a title and description for the PR. SEO Assist will suggest defaults based on the included changes.

4

Submit to GitHub

Click Submit to create the PR in your repository. You'll receive a link to review and merge it on GitHub.

Bundle Related Changes

Group related suggestions into a single PR for easier review. For example, bundle all meta tag improvements together rather than creating separate PRs for each file.

Pull Request Tracking

SEO Assist tracks all created PRs so you can monitor their status:

  • PR Number: Links directly to the GitHub PR
  • Status: Open, Merged, or Closed
  • Created Date: When the PR was created
  • Included Suggestions: List of changes in the PR

CI/CD Mode (Agency)

Agency tier users can enable CI/CD mode for automated SEO checking:

  • Pre-merge Checks: Automatically scan PRs for SEO issues before merging
  • Status Checks: Block merges if critical SEO issues are detected
  • Automated Comments: Post suggestions directly on PR diffs
  • Scheduled Scans: Regularly scan main branch for regressions

Repository Permissions

To create pull requests, ARKA AI needs write access to your repository. If you only granted read access during setup, you'll need to update permissions in your GitHub settings.

Best Practices

  • Review all suggestions carefully — AI suggestions are helpful starting points but may need adjustments for your specific context.
  • Test changes in staging — Always deploy to a staging environment first to verify SEO changes work as expected.
  • Keep PRs focused — Smaller, focused PRs are easier to review and less likely to introduce issues.
  • Document decisions — If you reject a suggestion, add a note explaining why for future reference.