Skip to content

[PXCT-1779] document custom bricks#2944

Draft
swikstrom wants to merge 1 commit into
mainfrom
app-lab-custom-bricks-documentation
Draft

[PXCT-1779] document custom bricks#2944
swikstrom wants to merge 1 commit into
mainfrom
app-lab-custom-bricks-documentation

Conversation

@swikstrom
Copy link
Copy Markdown
Contributor

What This PR Changes

  • Document custom bricks

Contribution Guidelines

@swikstrom swikstrom marked this pull request as draft May 7, 2026 06:36
@swikstrom swikstrom changed the title document custom bricks [PXCT-1779] document custom bricks May 7, 2026

### Docker Containers (`brick_compose.yaml`)

If your Custom Brick requires external services, you can define them using a Docker Compose file. The system will automatically pull and run these containers alongside your App.
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.

Suggested change
If your Custom Brick requires external services, you can define them using a Docker Compose file. The system will automatically pull and run these containers alongside your App.
If your Custom Brick requires external services, you can define them in this file. `brick_compose.yaml` is a Docker Compose file:
https://docs.docker.com/reference/compose-file/
The system will automatically pull and run these containers alongside your App.
  • Adjust wording to make it clear that brick_compose.yaml is the referenced Docker Compose file.
  • Link to the essential high quality Docker Compose file documentation

```yaml
services:
my_service:
image: custom_registry/my_service:latest
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.

Suggested change
image: custom_registry/my_service:latest
image: some_registry/some_image:latest
  • Adjust placeholder reference components to avoid giving the false impression that use of an image created by the user is required. Existing containers may also be utilized in custom Bricks.
  • Use correct "image" term (reference).


## Using Your Custom Brick

Once created, using a Custom Brick is identical to using a built-in Brick. Import the class from your package and initialize it in your App's `main.py`.
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.

Suggested change
Once created, using a Custom Brick is identical to using a built-in Brick. Import the class from your package and initialize it in your App's `main.py`.
Once created, using a Custom Brick is identical to using a built-in Brick. Import the class from the Python package in the Brick and initialize it in your App's `main.py`.

Adjust wording to make it more clear what is being referred by "your package".

App.run()
```

## AI Models in Custom Bricks
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.

This is certainly better than no documentation of the feature at all, so I'm fine with shipping the initial version of the docs with this as-is. However, I feel that it doesn't provide nearly enough information for the average user to be able to utilize the feature without reverse engineering how it is done in the built-in Bricks.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants