[PXCT-1779] document custom bricks#2944
Draft
swikstrom wants to merge 1 commit into
Draft
Conversation
per1234
requested changes
May 8, 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. |
Contributor
There was a problem hiding this comment.
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.yamlis 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 |
Contributor
There was a problem hiding this comment.
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`. |
Contributor
There was a problem hiding this comment.
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 |
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What This PR Changes
Contribution Guidelines