[codex] Align README mountApp examples with app registration#199
Merged
Conversation
Update the README wrapper, not-found, and navigation behavior examples to keep passing the explicitly registered app into mountApp. Add docs regression coverage so README examples stay aligned with the registered-app setup.
samlaycock
marked this pull request as ready for review
May 19, 2026 20:28
Greptile SummaryThis PR fixes four README
Confidence Score: 5/5Documentation-only change with no runtime code modified; all four updated examples are consistent with the existing docs-site patterns. All changes are confined to README prose and a test file. The README examples now consistently pass No files require special attention.
|
| Filename | Overview |
|---|---|
| README.md | Four mountApp examples updated to include the registered app in the options object, with matching import { app } from "./app" statements added to each snippet. |
| tests/docs-package-names.test.ts | Regression assertions added for all five README mountApp patterns; reads README via the existing readDoc/normalizeWhitespace helpers that collapse whitespace, so multi-line blocks match correctly. |
| .changeset/registered-app-readme-examples.md | Patch changeset added for the documentation fix; correctly targets the litzjs package. |
Reviews (1): Last reviewed commit: "docs: align readme mountApp examples" | Re-trigger Greptile
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.
Summary
Closes #192.
Updates the README Quick Start
mountApp(...)examples so wrapper components, custom not-found UI, and navigation behavior options continue passing the explicitly registeredappthrough the options object.The docs site quick-start examples already used
mountApp(root, { app, component: ... }), so the implementation change is limited to the README. I also added regression coverage to the existing docs package-name test to check the README examples alongside the docs-site examples.Root Cause
The README introduced explicit app registration with
mountApp(root, { app }), but the follow-up examples omittedappwhen addingcomponent,notFound,scrollRestoration, andfocusManagementoptions. That made registered-app setup look optional in examples that build on the same app entry.Validation
bun test tests/docs-package-names.test.tsbun fmtbun lint:fixbun testbun typecheckbun lintChangeset
Added
.changeset/registered-app-readme-examples.mdas a patch changeset for the documentation update.