Skip to content

docs: Migrate code review docs#1055

Merged
factory-nizar merged 1 commit intomainfrom
docs/code-review-docs-migration
Apr 30, 2026
Merged

docs: Migrate code review docs#1055
factory-nizar merged 1 commit intomainfrom
docs/code-review-docs-migration

Conversation

@TheFactoriousDROID
Copy link
Copy Markdown
Contributor

Summary

  • Move Automated Code Review into Capabilities as a top-level page so the canonical automated review setup is discoverable from the main docs IA.
  • Rename the /review docs to Local Code Review and keep it as a top-level capability so local review and automated review are clearly separated.
  • Retire the GitHub App install pages and redirect deprecated GitHub App URLs directly to Automated Code Review because /install-code-review is now the current setup path.
  • Update CLI reference and welcome-page links to use /install-code-review and the new Code Review naming.

Risk / impact

  • Docs-only IA and copy change.
  • Deprecated GitHub App URLs are redirected directly to the replacement page to avoid broken links and redirect chains.

Testing

  • npm run check
  • Local Mintlify preview verified for /guides/droid-exec/code-review.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 30, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
factory 🟢 Ready View Preview Apr 30, 2026, 12:43 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@factory-droid
Copy link
Copy Markdown
Contributor

factory-droid Bot commented Apr 30, 2026

Droid finished @TheFactoriousDROID's task —— View job


LGTM — no high-confidence issues found in this docs-only change.

Copy link
Copy Markdown
Contributor

@factory-nizar factory-nizar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments!

3. Walk you through review configuration (depth, security, triggers)
4. Create a PR/MR with the workflow files

You can also use `/install-github-app` for GitHub-only setup. For detailed setup instructions, see the [GitHub App installation guide](/integrations/github-app).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we can keep this but replace the command with /install-code-review

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is the /install-code-review doc itself (already mentioned in line 24). The old github-app page redirects here.


## See also

- [GitHub App installation](/integrations/github-app) - Full setup guide for `/install-github-app`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is the Automated Code Review page already, we'd be redirecting to the current page. The github-app page was just an obsolete 3rd page (not local or automated, which we're keeping).

Old gh-app url will redirect to automated code review page

droid exec "Review the changes in this PR for security issues and performance regressions"
```
See the [Code Review guide](/guides/droid-exec/code-review) for automation examples.
See the [Automated Code Review guide](/guides/droid-exec/code-review) for automation setup.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we also want to move this page somewhere more discoverable/ top level

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2026-04-29 at 6 12 52 PM

screenshot from the preview deploy

@factory-nizar factory-nizar merged commit 9edebc9 into main Apr 30, 2026
17 checks passed
@factory-nizar factory-nizar deleted the docs/code-review-docs-migration branch April 30, 2026 01:50
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