7546 - Add initial placeholder in VC BoK dialog

[reactoholic]

Add initial placeholder in VC BoK dialog

Summary by CodeRabbit

• New Features
  • Added a descriptive placeholder in the virtual contributor’s knowledge base field to guide users on where to find documents and texts that contribute to insights and functionality.
  • Enhanced the dialog interface so that if no custom description is provided, the placeholder text is displayed automatically.

[coderabbitai]

Walkthrough

This pull request introduces a new placeholder text for the "bodyOfKnowledge" field in the Virtual Contributor's settings. The placeholder is added to the translation JSON file and subsequently integrated into the KnowledgeBaseDialog component by updating its type definition and rendering logic. The dialog now utilizes this placeholder when no specific description is provided. Additionally, the VCProfileContentView component passes the new placeholder prop to the dialog, ensuring a consistent user experience regarding the component’s functionality.

Changes

File(s)	Change Summary
src/core/i18n/en/translation.en.json	Added a new "placeholder" text in the virtualContributorSpaceSettings section describing the collection of documents and texts.
src/domain/community/virtualContributor/knowledgeBase/KnowledgeBaseDialog.tsx	Updated the component’s prop types to include a placeholder property and modified the rendering logic to use placeholder as a fallback for the description.
src/domain/community/virtualContributor/vcProfilePage/VCProfileContentView.tsx	Passed the placeholder prop (retrieved via translation) to the KnowledgeBaseDialog component.

Sequence Diagram(s)

sequenceDiagram
    participant VC as VCProfileContentView
    participant T as Translation Service
    participant D as KnowledgeBaseDialog
    participant Desc as DescriptionComponent

    VC->>T: t('virtualContributorSpaceSettings.placeholder')
    T-->>VC: Returns placeholder string
    VC->>D: Render dialog with placeholder prop
    alt KnowledgeBaseDescription exists
        D->>Desc: Render with knowledgeBaseDescription
    else
        D->>Desc: Render with placeholder
    end

Loading

Possibly related PRs

• Small changes to VCflow wording translation.en.json #7573: Updates the JSON file with a new placeholder for the Virtual Contributor feature, closely aligning with the current JSON enhancements.
• vc profile page #7093: Introduces a new property to the KnowledgeBaseDialog component, sharing a similar purpose to the placeholder update in this PR.
• Fix can't add callout to VC KnowledgeBase. #7437: Modifies the KnowledgeBaseDialog component’s structure, which is related given the current changes involving its props.

Suggested labels

translations

Suggested reviewers

• reactoholic

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f67448 and b386545.

📒 Files selected for processing (1)

• src/core/i18n/en/translation.en.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/core/i18n/en/translation.en.json

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.