PCH Excerpt Suggestions: Add Persona and Tone settings

[acicovic]

Description

This PR adds Persona and Tone settings to our Excerpt Suggestions feature, in a similar manner to what already exists in our Title Suggestions feature.

Motivation and context

• Users want to be able to customize the persona and tone of generated excerpts.
• Closes Excerpt Suggestions: Allow different personas/styles #2692.

How has this been tested?

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (4)

• develop
• add/.*
• fix/.*
• update/.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[acicovic]

Notes:

• This work is currently based on our refactor/internal-api branch in order to avoid duplicate work since it adds a settings endpoint.
• @vaurdan, trying different things, I still couldn't make SettingsProvider to work. I suspect it might have to do with this being in Gutenberg Settings, and maybe a higher order component is needed as you've done previously for Smart Linking. Nothing has worked for me so far, but I'm probably missing something. Could you take a look?
• This PR is currently incomplete due to the previous point.

[acicovic]

@vaurdan: regarding my previous comment, let's also keep in mind that there's a feature request to have Excerpt Suggestions in the PCH Sidebar.

As this will probably affect how Excerpt Suggestions settings get saved, it would be good to factor this in during this work. If we're unsure of how this will play out, let's start implementing that request to avoid duplicate/refactoring work.

[vaurdan]

@acicovic I went ahead and added the SettingsProvider to the component. It was a bit trickier, because of how we're using a SlotFill to insert the Excerpt panel to the Document sidebar (Using PluginDocumentSettingPanel).

This required a bit of reworking on how the code is organized - instead of being a standalone module, I made it part of the editor-sidebar module. This will also help when we add the panel to the PCH sidebar, since that move would have to be done nonetheless.

From your original code, instead of having a new settings namespace for the excerpt generator, I changed it so it's also part of the main SidebarSettings namespace.

Let me know your thoughts, and if you have any questions!

[vaurdan]

Oh - I also renamed the component from excerpt-generator to excerpt-suggestions on a different commit 🙂

[acicovic]

Thank you for completing this work! I agree with renaming ExcerptGenerator to ExcerptSuggestions anywhere possible.

I've left a couple of comments, the only really important one being the one about the filter.

[vaurdan]

@acicovic I believe I addressed all your feedback! Let me know if you have any additional thoughts 🙂

I believe since you're the owner of this PR, you can't approve it, but if we have 🟢 , let me know and I can approve it myself.

[acicovic]

Thanks for addressing the filters situation!

I've left some minor comments.

[acicovic]

I've left a comment in our last discussion, but otherwise I think we're good to go. Let's not merge this though, until our API refactoring branch is merged first.

[acicovic]

Closing in favor of #2890.