GitHub pull requests

The Cortex Click GitHub app is an AI content editor that helps you write better developer marketing materials like blogs, tutorials, courses, and documentation. It draws context from your knowledge base including the rest of your product website, documentation, and code examples to provide high quality suggestions that improve your content.

Tag @cortexclick in any pull request comment to receive a suggested commit to improve your content. Suggested commits work on any markdown content in your GitHub repo, not just content created with Cortex Click.

The GitHub app also enables one-click publishing from within the Cortex Click app to publish any piece of generated content in a pull request.

Generating suggested commits on pull requests

The Cortex Click GitHub app is an AI content editor that boosts content quality and speeds up the review process. It has access to everything in your knowledge base including your docs, blog, and other marketing materials, and performs real time web research against popular search engines to fill in the gaps.

Tag @cortexclick in any GitHub pull request comment to get a suggested commit to improve your content. This works on content created and published by Cortex Click, as well as any pre-existing mardown files in your repo.

Comments on selected lines

Selecting a line or range of lines and tagging @cortexclick generates a suggested commit that only targets that portion of the PR. Reviewers can generate a suggested commit that the PR author can accept, or the PR author can respond to a long comment thread between reviewers to generate a suggested commit that resolves their feedback.

Top-level comments

Comments made at a top-level evaluate and make suggestions to the entire PR. This is useful for things like global spelling and grammar fixes, adding entirely new sections to the doc, or doing global refactors like updating the branding that you use to refer to a product.

Note: top-level comments are currently limited to content published by Cortex Click.

Opening a pull request from the Cortex Click app

Click the "publish" button on any piece of content within the Cortex Click app to open a PR in GitHub. Select from pre-configured publication targets, or specify a custom path and extension where the content will be created in your repo.

Installing and Configuring the GitHub app

GitHub app installation

You'll need to be an GitHub admin to install the Cortex Click GitHub app. You can choose to install it on all repos, or just the subset that corresponds to your docs and marketing websites. The app requires read and write permissions on code to publish pull requests and provide AI suggestions to your content.

Installing the Cortex Click GitHub app will redirect you to the Cortex Click app where you will associate your app installation with a specific org.

Configuring publication targets

Publication targets can be configured within organization settings and enable configuration of repositories and file path combinations for common publishing scenarios. This makes it easy for your team to publish content to common places like docs, blogs, tutorials and other sections of your website.