Skip to content

Conversation

@alecgeatches
Copy link
Contributor

@alecgeatches alecgeatches commented May 15, 2025

Description

This is a follow-up to #3329 which adds some additional label changes, rearrangement, and simplification of the interface for the 3.19 release. Here are the main changes:

  1. Any place where we use "Smart Link" in a label, it's been modified to be double capitalized as a proper noun (e.g. "smart links" -> "Smart Links")

  2. The "Generate" left-side button was removed in this commit. Generating new links doesn't typically lead to improved suggestions, and the selected posts are generally very similar to the initial set. This has been removed as an atomic commit to make it easier to re-add if we'd like.

  3. The "Regenerate" right-side button was removed in this commit. The logic here is that the user will likely take over to adjust the link, and clicking "Regenerate" probably doesn't add enough utility to make the button useful enough to add to the UI at this stage. Also done in a single commit to make it easy to revert.

  4. The "Suggestion" dropdown was removed from the footer.

    Screenshot 2025-05-15 at 4 54 23 PM

    We found three controls to switch between suggestions: The left sidebar of titles, the suggestion dropdown in the toolbar, and the left/right buttons in the toolbar. Because of the redundancy and the ability to move between suggestions more clearly in the sidebar, we removed that footer control.

  5. A handful of label updates to make it more clear what the target post is, and what the source posts are:

    Screenshot 2025-05-15 at 4 57 11 PM

    This will make it easier to document usage of traffic boost with less overlapping terminology and use standardized language for customers.

  6. Adds tooltips on footer left and right arrows with labels "Next Suggested Source" / "Previous Suggested Source".

Summary by CodeRabbit

  • New Features

    • None.
  • Bug Fixes

    • None.
  • Style

    • Improved consistency and clarity of user-facing text by capitalizing "Smart Link(s)" and related phrases throughout the interface, notifications, error messages, and REST API descriptions.
    • Updated various labels and button text for clarity, such as changing "Add" to "Add Source Post", "Current Post" to "Target Post", and "Link Suggestions" to "Suggested Sources".
    • Enhanced tooltip descriptions for navigation buttons.
  • Refactor

    • Removed the ability to regenerate suggestions and inbound links from the Traffic Boost preview and sidebar, simplifying related UI and controls.
    • Streamlined the PreviewFooter component by removing the "Regenerate" button and suggestion navigation dropdown.
  • Documentation

    • None.
  • Chores

    • None.
  • Tests

    • None.
  • Revert

    • None.

@alecgeatches alecgeatches added this to the 3.19.0 milestone May 15, 2025
@alecgeatches alecgeatches self-assigned this May 15, 2025
@alecgeatches alecgeatches requested a review from a team as a code owner May 15, 2025 23:00
@alecgeatches alecgeatches added the Feature: Engagement Boost Ticket/PR related to Engagement Boost label May 15, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 15, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (4)
  • build/content-helper/dashboard-page.asset.php is excluded by !build/**
  • build/content-helper/dashboard-page.js is excluded by !build/**
  • build/content-helper/editor-sidebar.asset.php is excluded by !build/**
  • build/content-helper/editor-sidebar.js is excluded by !build/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

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

📝 Walkthrough

Walkthrough

This update standardizes the capitalization of "Smart Link(s)" and related phrases across user-facing strings, error messages, REST API descriptions, and UI components. It also removes the regeneration feature and related UI from the Traffic Boost preview and suggestions workflow, updates several button labels and tab titles for clarity, and makes minor style adjustments to the sidebar.

Changes

File(s) Change Summary
src/Models/class-inbound-smart-link.php
src/rest-api/content-helper/class-endpoint-smart-linking.php
src/rest-api/content-helper/class-endpoint-traffic-boost.php
Standardized the capitalization of "Smart Link(s)" in WP_Error messages, REST API parameter descriptions, and error messages for consistency across the backend and API. No logic or control flow changes.
src/content-helper/dashboard-page/pages/traffic-boost/preview/components/link-counter.tsx
src/content-helper/editor-sidebar/smart-linking/component.tsx
src/content-helper/editor-sidebar/smart-linking/hooks.ts
src/content-helper/editor-sidebar/smart-linking/review-modal/component-modal.tsx
src/content-helper/dashboard-page/pages/traffic-boost/preview/hooks/use-iframe-highlight.ts
Updated user-facing strings to capitalize "Smart Link(s)" or "Smart Links" for consistency. No logic or control flow changes.
src/content-helper/dashboard-page/pages/traffic-boost/preview/components/preview-footer.tsx
src/content-helper/dashboard-page/pages/traffic-boost/preview/preview.tsx
src/content-helper/dashboard-page/pages/traffic-boost/sidebar/components/tabs/suggestions-tab.tsx
Removed all code, props, and UI related to regenerating suggestions and inbound links from the Traffic Boost preview and suggestions tab. Navigation tooltips were added to suggestion navigation buttons.
src/content-helper/dashboard-page/pages/traffic-boost/sidebar/components/add-new-link-button.tsx Changed the button label from "Add" to "Add Source Post" for clearer intent.
src/content-helper/dashboard-page/pages/traffic-boost/sidebar/components/post-details.tsx Changed "Current Post:" to "Target Post:" and clarified descriptive text to "high-performing related source posts."
src/content-helper/dashboard-page/pages/traffic-boost/sidebar/sidebar.tsx Changed the first tab title from "Link Suggestions" to "Suggested Sources" for improved clarity.
src/content-helper/dashboard-page/pages/traffic-boost/sidebar/sidebar.scss Increased font size for post titles and adjusted tab item padding for improved UI appearance.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TrafficBoostPreview
    participant PreviewFooter
    participant SuggestionsTab

    User->>TrafficBoostPreview: Opens Traffic Boost preview
    TrafficBoostPreview->>PreviewFooter: Renders footer (no regenerate button)
    User->>SuggestionsTab: Views suggestions
    SuggestionsTab-->>User: Shows AddNewLinkButton only (no generate button)
    User->>PreviewFooter: Navigates suggestions using prev/next buttons with tooltips
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@alecgeatches
Copy link
Contributor Author

@acicovic I think the SonarCloud failure here is ignorable, it's complaining about duplicated code in internationalized strings which is fine to me.

Copy link
Collaborator

@acicovic acicovic left a comment

Choose a reason for hiding this comment

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

Thanks for working on this. All changes make sense to me conceptually. We can amend as/if needed in the future.

I'm going to merge this PR immediately.

@acicovic acicovic merged commit a2e7128 into add/traffic-boost May 16, 2025
38 of 39 checks passed
@acicovic acicovic deleted the update/traffic-boost-ui branch May 16, 2025 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature: Engagement Boost Ticket/PR related to Engagement Boost

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants