docs(integrations): clarify entry accepts any fragment key + FAST-v3 wrapper requirement#308
Open
janechu wants to merge 1 commit into
Open
Conversation
…wrapper requirement Two small clarifications carried forward from the discussion on #299 (which was closed in favour of inline updates rather than a separate recipe page): 1. Both Node and Rust integration pages now explicitly state that `entry` / `entry_id` accepts any fragment key, not just `"index.html"`. Adds a 'webui inspect' pointer for listing the valid keys in a built protocol. 2. Calls out the FAST-v3 wrapper-file requirement: an `<f-template name="...">` block lives in the protocol's component map (not the fragment map), so it cannot be passed as `entry` directly. Adopters trying to render a single FAST-v3 component into an embedded host were hitting MissingFragment and had to read source to figure out why. Also adds a one-line distinction between `render_partial` (returns JSON for the WebUI client-side router during in-app navigation) and `render` / `WebUIHandler::handle` with `entry` (returns raw HTML for a non-WebUI host), since these two APIs were being conflated and the existing docs don't make the distinction explicit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Two small clarifications carried forward from the discussion on #299 (which was closed in favour of inline updates rather than a separate recipe page, per maintainer preference):
Both
docs/guide/integrations/node.mdanddocs/guide/integrations/rust.mdnow explicitly state thatentry/entry_idaccepts any fragment key in the built protocol, not just"index.html". Adds awebui inspectpointer for listing the valid keys.Calls out the FAST-v3 wrapper-file requirement: an
<f-template name="my-component">block lives in the protocol's component map (not the fragment map), so it cannot be passed asentrydirectly. Adopters trying to render a single FAST-v3 component into an embedded host were hittingMissingFragmentand had to read source to figure out why.Also adds a one-line distinction between
render_partial(returns JSON for the WebUI client-side router during in-app navigation) andrender/WebUIHandler::handlewithentry(returns raw HTML for any host), since these two APIs were being conflated in the discussion on #299 and the existing docs don't make the distinction explicit.Why
The existing integration pages say
entryis "Fragment ID to start rendering from" but only ever showentry: 'index.html'in examples. An adopter has to read the source to figure out (a) that they can pass any fragment, (b) how to list valid keys, and (c) why their FAST-v3<f-template>block doesn't work as an entry. These three points together are ~20 lines of doc that pay back the source-reading exercise.How I tested
cargo xtask license-headers✔cargo fmt --all --check✔ (docs-only change; ran for sanity)Notes
users/janechu/clarify-embedded-entry-in-integration-docsper my host repo's agent-driven branch convention.