Update docs to account for recent changes #808
Conversation
Co-authored-by: Shayne Czyzewski <[email protected]>
Co-authored-by: Martin Šošić <[email protected]>
…into filip-js-go-to-definition
…into filip-js-go-to-definition
sodic
force-pushed
the
filip-update-docs-new-structure
branch
from
8eb1c76 to
313d2b7
Compare
sodic
changed the title
There was a problem hiding this comment.
Awesome attention to detail here, @sodic. I know it was a lot of effort to get all this updated. Nice job!
One page I noticed that still references @ext is the main page web/src/pages/index.js, as does one line in features.md (js title="ext/myClientSetupCode.js")
I tried to drop in suggested edits where I thought they made sense, but even my eyes could not be trusted near the end of reviewing it all haha :D It all becomes very sneaky/subtle, so take them with a grain of salt. I will do another review with fresh eyes after you have a chance to check out the ideas here. 👍🏻
| ├── .gitignore | ||
| ├── main.wasp # Our wasp code goes here. | ||
| ├── src | ||
| │ ├── client # Our external client code (JS/CSS/HTML) goes here. |
There was a problem hiding this comment.
Even though this convention was here before, and you explained it well below, I still find "Our external code" a bit confusing. On these three lines, is it ok if we just say "Your client code", etc.?
| @@ -11,13 +11,19 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; | |||
| To enable support for Tailwind in your Wasp project, you simply need to add two config files (`tailwind.config.js` and `postcss.config.js`) to the root directory. When they are present, Wasp will add the necessary NPM dependencies and copy your config files into the generated project output. You can then start adding [Tailwind CSS directives](https://tailwindcss.com/docs/functions-and-directives#directives) to your CSS files and `className`s to your React components. | |||
|
|
|||
| ### New project tree overview | |||
There was a problem hiding this comment.
Thanks for updating this one
|
|
||
| When referencing code from `src/client` in your `*.wasp` file, you do it as `@client/relative/path/of/file/in/the/client/dir`. | ||
|
|
||
| You can't reference shared code inside the Wasp file, but you can import and use it in all code that lives in `src/client` or `src/server`. Use a relative import to do this. For example, the file `src/server/something.js` can import a shared function from `src/shared/utilities.js` like this: |
There was a problem hiding this comment.
Ok, I see what you meant in the other PR now, thnx.
web/docs/language/features.md
Outdated
| entities: [Task] | ||
| } | ||
| ``` | ||
|
|
||
| And here is how you might use it: | ||
| ```js {4,18} title=pages/Task.js | ||
| ```js {4,18} title=client/pages/Task.js |
There was a problem hiding this comment.
I know the previous versions just used pages, but do we want to always preface with src/ moving forward?
|
Wow @shayneczyzewski, thanks for noticing all of those. I thought I went through it a couple of times, but I guess I was too tired and biased to see it. I'll implement all the changes and mark your comments with 🚀 when they're up. |
Co-authored-by: Shayne Czyzewski <[email protected]>
Co-authored-by: Shayne Czyzewski <[email protected]>
Co-authored-by: Shayne Czyzewski <[email protected]>
Co-authored-by: Shayne Czyzewski <[email protected]>
… into filip-update-docs-new-structure
Co-authored-by: Shayne Czyzewski <[email protected]>
Crap, forgot about the blogs 😅 I'll have it ready by tomorrow and let you know. The other stuff you mentioned is fixed and pushed. |
|
@shayneczyzewski Ok, all done:
|
There was a problem hiding this comment.
Awesome job here @sodic. A TON of effort to update all this, so well done 👏🏻 Two minor things but looks ready to roll to me 👍🏻 Great job
Co-authored-by: Shayne Czyzewski <[email protected]>
Co-authored-by: Shayne Czyzewski <[email protected]>
… into filip-update-docs-new-structure
Updates the docs together with the Todo example apps to account for recent changes in the project structure, covers documentation differences for: