docs: walkthrough of the client libraries #1401
Conversation
|
There was a problem hiding this comment.
I like the explanations in here! I almost wonder if it would make sense to have these as comments in the actual files instead of separately. (Thinking of how to keep this walkthrough in sync with the actual files, and people would probably first look in the file that's created in their project before looking on the docs page.) For now we can merge it as is to be able to point people to this page if they care about the files that are created when starting a MUD template.
| @@ -0,0 +1,381 @@ | |||
| # The MUD client libraries | |||
|
|
|||
| In this code walkthrough you learn how the MUD client libraries function. | |||
There was a problem hiding this comment.
When I hear "MUD client libraries" I think of the libraries in MUD, while the files in the mud directory are mostly boilerplate that has to live in the project for various reasons, but we're trying to reduce the amount of boilerplate that has to live in the project because projects can't update it like other files.
I'd probably call these files something like "client template setup files"
|
|
||
| The type definition for the return type of `setup`. | ||
| The result is an [`Awaited`](https://www.typescriptlang.org/docs/handbook/utility-types.html#awaitedtype), which means it may be the result of an input/output operation that is not immediately available. | ||
| The `Awaited` result uis of type `ReturnType<typeof setup>`, which means that TypeScript will see the type that the `setup` function returns and use that. |
There was a problem hiding this comment.
| The `Awaited` result uis of type `ReturnType<typeof setup>`, which means that TypeScript will see the type that the `setup` function returns and use that. | |
| The `Awaited` result is of type `ReturnType<typeof setup>`, which means that TypeScript will see the type that the `setup` function returns and use that. |
| The one you see here is to get on the `anvil` test network by default | ||
|
|
||
| { | ||
| // ** GOON link to how to change it when https://github.com/latticexyz/mud/pull/1369 is merged ** |
There was a problem hiding this comment.
What does GOON mean in this context? 😄
There was a problem hiding this comment.
Go on. I use it as a note for myself.
Then let's just do that. Do I need to PR changes into each of the templates separately, or are those files all coming from a single source somewhere? |
Co-authored-by: alvarius <alvarius@lattice.xyz>
No description provided.