docs: document portal UI and server libraries - #255
Merged
Merged
Conversation
## What changed
Document the marketplace UI's new `uiConfig.filters` Luigi context field in
`reference/components/marketplace.md`, alongside the existing Configuration
table.
## Why
The marketplace UI now builds its provider-catalog filter row dynamically
from `uiConfig.filters` instead of always rendering hardcoded Category and
Provider filters. This documents the new config surface so integrators know
how to drive the catalog's filtering UI without a UI code change.
## Details
- Added a `uiConfig.filters` row to the context-fields table.
- Explained the `{label, providerMetadataPath}` shape: one filter control per
entry, no entries means no filter row at all.
- Explained that `providerMetadataPath` is a dot-path resolved against each
provider's `ProviderMetadata`, transparently walking through JSON-encoded
sub-objects such as `spec.data` (e.g. `spec.data.category`).
- Explained option derivation (distinct values found across the catalog) and
filtering semantics (selection narrows results, empty selection shows all).
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: gkrajniak <gkrajniak@gmail.com>
## What changed Extend the Portal reference page with the libraries it is built from and add sub-pages for `@platform-mesh/portal-ui-lib` and `@platform-mesh/portal-server-lib`. Refs platform-mesh/portal#340 ## Why The Portal page described the runtime behavior but not that the frontend and backend are assembled from the OpenMFP portal libraries plus the Platform Mesh portal libraries. The generic UI, which lets providers render resources without building a microfrontend, was not documented on the site at all. ## Details - `reference/components/portal.md`: new Architecture section with the library layering; repositories and related links for both libraries. - `reference/components/portal/portal-ui-lib.md`: library purpose, entry points, registered web components, a summary of the generic UI configuration, and a link to the full generic UI guide. - `reference/components/portal/portal-server-lib.md`: the providers passed to `PortalModule.create()` and their responsibilities. - Sidebar, components index, and `llms.txt` list the new pages. - `.vitepress/config.mts`: pre-bundle `mermaid` in the dev server. Mermaid imports the CommonJS-only `fastdom` package, which broke `vitepress dev` with a blank page (`does not provide an export named 'default'`). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: gkrajniak <gkrajniak@gmail.com>
lpgarzonr
approved these changes
Sep 17, 2026
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
2 participants
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 changed
Extend the Portal reference page with the libraries it is built from and add
sub-pages for
@platform-mesh/portal-ui-liband@platform-mesh/portal-server-lib.Refs platform-mesh/portal#340
Why
The Portal page described the runtime behavior but not that the frontend and
backend are assembled from the OpenMFP portal libraries plus the Platform Mesh
portal libraries. The generic UI, which lets providers render resources
without building a microfrontend, was not documented on the site at all.
Details
reference/components/portal.md: new Architecture section with the librarylayering; repositories and related links for both libraries.
reference/components/portal/portal-ui-lib.md: library purpose, entrypoints, registered web components, a summary of the generic UI
configuration, and a link to the full generic UI guide.
reference/components/portal/portal-server-lib.md: the providers passed toPortalModule.create()and their responsibilities.llms.txtlist the new pages..vitepress/config.mts: pre-bundlemermaidin the dev server. Mermaidimports the CommonJS-only
fastdompackage, which brokevitepress devwith a blank page (
does not provide an export named 'default').http://github.com/platform-mesh/portal/issues/340