Document the client/server component boundary - #219
Open
greatest0fallt1me wants to merge 1 commit into
Open
Conversation
docs/client-server-boundary.md already existed and is accurate/complete (the rule, real examples from this repo, a boundary-by-layer table, and the common "use client" leaks downstream mistake), but nothing linked it or docs/wallet-connection-state-machine.md from anywhere a contributor would find them. Add a Documentation section to the README.
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
1 participant
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.
Note on scope
`docs/client-server-boundary.md` already exists and is thorough and accurate: the rule for when `"use client"` is needed, real examples from this repo (Server/Client/presentational), a boundary-by-layer table, and the common "use client leaks downstream" mistake. It just wasn't discoverable -- nothing in the README linked it, or the other existing doc (`docs/wallet-connection-state-machine.md`).
Change
Added a Documentation section to the README linking both docs.
Closes #101