Repository navigation
docs(frontend): correct statements and document Web Host 1.0.69 - #56
Draft
AndrewKirkovski wants to merge 4 commits into
Draft
AndrewKirkovski wants to merge 4 commits into
AndrewKirkovski wants to merge 4 commits into
Conversation
The English frontend pages were compared with Web Host 1.0.68, @wippy-fe/* 0.0.68, facade 0.6.51 and the views module. This change corrects the statements that disagree with the code and moves the release baseline from 1.0.66 to 1.0.68. Corrections that changed behavior for a reader who follows the docs: - window.__WIPPY_CONFIG_OVERRIDES__ is removed from four pages. The Host merges page overrides before it sends config to the page and no longer reads that global. - The PrimeVue stylesheet holds the .p-* component classes only. It does not deliver Tailwind utilities; a module compiles its own. - The navigation list reads title and icon from the registry entry only. The Quickstart entry now sets both. - A page customCSS replaces the facade CSS for that page. axiosDefaults is merged one level deep and apiRoutes is replaced. - allowSelectModel, hideSessionSelector and allowAdditionalTags are root fields of the facade response under the default policy. - css_variables in the debugging page is a JSON string, not a YAML map. - The base tag includes the directory of the entry file. - An announced inline page stays in the list API with hidden: 1. Corrections to examples and reference details: - movePanel uses a valid position value. - WippyElement examples read the typed host with getWippyHost, and useEvents takes its event map, so the examples pass a type-check. - wippy.props is needed by loadWebComponent; the component entry default comes from the top-level browser field. - Schema name 2.2, iframe injection order, the @history payload, and one PrimeVue plugin import form. Baseline: version statements that were checked again at 1.0.68 now name 1.0.68 and 0.0.68. The checker pins follow. Because the checker pins packages.md and web-host/overview.md in every locale, the version numbers on those two pages move in all locales; no other text in other locales changes. Left as they are: statements about what a feature did in 1.0.66 that were not checked again, the cdn-assets page, and the two generated catalogue pages, which still say they were generated from theme 0.0.66.
Multi-panel layout (all locales): - Add the @HOST/chat-wrapper options closable, emptyState and startToken, including how a coordinator tells a selector pick from a finished start. - Add the @HOST/panel-tab mode 'auto'. - Document the wippy-host-app class on the managed root. - State that a current but hidden page's startChat/openSession/openArtifact/navigate calls reach the coordinators, and that chat-wrapper is not visible for attention while its column is collapsed. - Add a 1.0.69 row to the release map. Move current-release mentions from 1.0.68 to 1.0.69 and from 0.0.68 to 0.0.69 (and the 1.0.66 pins in the non-English build-system, host-less-mode and multi-panel-layout pages). Update the facade default Host URL and the current facade version (0.6.52) in framework/facade.md and cdn-assets.md, and the version pins in scripts/check-frontend-docs.mjs.
Since Web Host 1.0.69 each declared coordinator has its own bounded queue (32 intents) and receives every intent once, in the order raised. A coordinator that subscribes first does not use up the intents of the others, a coordinator that never mounts blocks no one, an intent whose page was replaced while it waited is discarded, and a declaration with no coordinators entry queues nothing. Replace the "held until the first coordinator subscribes" statements in the multi-panel layout page, in all locales.
This branch has not been deployed
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 changed
The English frontend pages were compared with the code of Web Host 1.0.68,
@wippy-fe/*0.0.68, facade 0.6.51 and the views module. This pull request corrects the statements that disagree with the code and moves the release baseline from 1.0.66 to 1.0.69. It also documents the managed-layout chat options that Web Host 1.0.69 added.Web Host 1.0.69 managed layout (
web-host/multi-panel-layout.md, all 8 locales)@HOST/chat-wrapperoptionsclosable,emptyStateandstartToken, with an example, and how a coordinator tells a session pick from a finished start.@HOST/panel-tabmodes, includingmode: 'auto'.wippy-host-appclass on the managed root, so host-only CSS applies in managed mode.host.startChat(),openSession(),openArtifact()andnavigate()to the coordinators.The source is the Host
CHANGELOG.mdsection 1.0.69 andmanaged-layout.mdat tagwebcomponents-1.0.69.Corrections that change what a reader does
micro-frontend-app-theming,proxy-api,css-injection,proxy-isolationwindow.__WIPPY_CONFIG_OVERRIDES__for runtime overridesmeta.config_overridesorwippy.configOverridesand are merged by the hostcss-injection,design-layer,web-component-theming,view-page.p-*component classes only. A module compiles the utilities it usesview-page,registry-entries,quickstarttitleandiconfrompackage.jsonare registry defaultsmeta.titleandmeta.icononly. The Quickstart entry now sets bothmicro-frontend-app-theming,proxy-apicssVariablesis replaced;axiosDefaultsandapiRoutesare deep mergedcustomCSSalso replaces the facade CSS.axiosDefaultsmerges one level deep.apiRoutesis replacedentry-pointallowSelectModel,hideSessionSelector,allowAdditionalTagsarehostConfigfieldshost_policy_modeis describeddebuggingcss_variableswritten as a YAML mapregistry-entries<base>tag is<url>/<base_path>/view-pageinlinepage is hidden from all listingshidden: 1Corrections to examples and reference details
proxy-api:movePaneluses a validpositionvalue. The@historypayload showsnavId.packages,multi-panel-layout: theWippyElementexamples read the typed host withgetWippyHost<...>(this), anduseEventstakes its event map. The examples now pass a strict type-check against the published packages.view-component:wippy.propsis needed byloadWebComponent(). The entry default comes from the top-levelbrowserfield.micro-frontend-app-theming: the schema name iswippy-context-2.2.css-injection: the iframe stylesheet order is themeConfig, iframe, primevue, markdown. An omittedproxyblock enables every injection.micro-frontend-app: the PrimeVue plugin uses the named import, the same form as the other two recipes.Baseline
The current-release version mentions now name 1.0.69 and 0.0.69, and the facade pages name facade 0.6.52, which selects Host 1.0.69. The corrections above were checked against 1.0.68; the 1.0.69 changelog changes none of those areas. The pins in
scripts/check-frontend-docs.mjsfollow. Version mentions that pair with a fixed tested set stay as they are: the facade tutorial (facade 0.6.46 with Host 1.0.66) andattention-quickstart.md(1.0.67).How to verify
All three pass on this branch.
Evidence for the two largest corrections:
window.__WIPPY_CONFIG_OVERRIDES__: the Web Host source at tagwebcomponents-1.0.68has no reference to it, and its changelog records the removal. The merge is insrc/shared/app-config/migration.ts(buildChildPayload).https://web-host.wippy.ai/webcomponents-1.0.68/@wippy-fe/assets/tailwind.csshas 828 distinct leading class names, and 826 of them start withp-.Known gaps
cdn-assets.md(not reviewed), statements about what a feature did in 1.0.66 inchat-web-components.md,packages.mdandentry-point.md, and the two generated catalogue pages, which need the generator.api/fragment_service.lua) also says the PrimeVue asset carries Tailwind utilities. This pull request documents what the built file contains. If the Host is meant to ship utilities, that point should be fixed in the Host build and reverted here.@messagerow inproxy-api.mdlists four subscription patterns and the code subscribes to three. Which side is wrong is not decided.