Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The with-islands island-architecture example needs documentation #209

Open
cdoremus opened this issue Nov 14, 2022 · 0 comments
Open

The with-islands island-architecture example needs documentation #209

cdoremus opened this issue Nov 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@cdoremus
Copy link
Contributor

The use-islands example is a bit of a wrinkle on Ultra that needs to be documented. Things that need an explanation include:

  • The server.ts file changes compared to the basic example (and point-out the missing client.ts file)
  • The IslandComponent wrapper
  • The hydrationStrategy attribute and its options

I suggest you add a section to the official docs on the island-architecture option with Ultra and reference that section in the with-islands/README.md file (or just add the documentation to the readme).

@deckchairlabs deckchairlabs added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants