Skip to content

Add readability refinement prompt to ai-tools#45117

Open
parthmax2 wants to merge 1 commit into
github:mainfrom
parthmax2:add-readability-prompt
Open

Add readability refinement prompt to ai-tools#45117
parthmax2 wants to merge 1 commit into
github:mainfrom
parthmax2:add-readability-prompt

Conversation

@parthmax2

Copy link
Copy Markdown

Adds src/ai-tools/prompts/readability.md, a new prompt type for the ai-tools CLI that edits articles for clarity and scannability while preserving meaning, frontmatter, and Liquid syntax. Follows the full-file output style used by the versioning prompt, so it is auto-registered as --prompt readability with no code changes. This is one of the future refinement types listed in the ai-tools README.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Adds src/ai-tools/prompts/readability.md, a new prompt type for the
ai-tools CLI that edits articles for clarity and scannability while
preserving meaning, frontmatter, and Liquid syntax. Follows the
full-file output style used by the versioning prompt, so it is
auto-registered as `--prompt readability` with no code changes. This is
one of the future refinement types listed in the ai-tools README.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 11, 2026 20:12

Copilot AI left a comment

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jul 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:

  • src/ai-tools/prompts/readability.md

You'll need to revert all of the files you changed that match that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

The complete list of files we can't accept are:

  • .devcontainer/**
  • .github/**
  • data/reusables/rai/**
  • Dockerfile*
  • src/**
  • package*.json
  • content/actions/how-tos/security-for-github-actions/security-hardening-your-deployments/**

We also can't accept contributions to files in the content directory with frontmatter contentType: rai.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants