Skip to content

Refactor: rename contact samples to custom-components-example#1019

Open
dmandar wants to merge 3 commits intomainfrom
md-reorg_contact
Open

Refactor: rename contact samples to custom-components-example#1019
dmandar wants to merge 3 commits intomainfrom
md-reorg_contact

Conversation

@dmandar
Copy link
Copy Markdown
Collaborator

@dmandar dmandar commented Mar 28, 2026

Description

Renamed the agent and the client to something clearer. Will have a separate MCP apps only sample.

Pre-launch Checklist

  • [ X] I signed the CLA.
  • [ X] I read the Contributors Guide.
  • [ X] I read the Style Guide.
  • [ X] I have added updates to the CHANGELOG.
  • [ X] I updated/added relevant documentation.
  • [ X] My code changes (if any) have tests.

If you need help, consider asking for advice on the discussion board.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request renames the "contact" and "contact_multiple_surfaces" sample to "custom-components-example" across the agent and client codebases, updating documentation, workspace configurations, and test paths. The review feedback identifies several remaining inconsistencies where the old naming or descriptions are still present, specifically within the test catalog configurations, the Python package name in the lock file (which requires a change in pyproject.toml), and the npm package description.

"path": SAMPLES_DIR / "custom-components-example",
"catalogs": [
CatalogConfig.from_path(
name="contact_multiple_surfaces_inline_catalog",
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.

medium

For consistency with the renaming of the sample from contact_multiple_surfaces to custom-components-example, the name of this CatalogConfig should also be updated. This will improve clarity and maintainability of the tests.

Suggested change
name="contact_multiple_surfaces_inline_catalog",
name="custom-components-example_inline_catalog",

@@ -91,7 +91,7 @@ requires-dist = [
[[package]]
name = "a2ui-contact-multiple-surfaces"
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.

medium

The package name here is inconsistent with the directory rename to custom-components-example. The package name should be updated to a2ui-custom-components-example in the corresponding pyproject.toml file to maintain consistency across the project. After updating pyproject.toml, this lock file should be regenerated.

name = "a2ui-custom-components-example"

"name": "@a2ui/custom-components-example",
"private": true,
"version": "0.8.1",
"description": "A2UI Contact Demo",
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.

medium

The package description still refers to 'Contact Demo'. To align with the renaming of the package to custom-components-example, it would be clearer to update the description as well.

Suggested change
"description": "A2UI Contact Demo",
"description": "A2UI Custom Components Example Demo",

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

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant