docs: Add frontend guide #5852
docs: Add frontend guide #5852
Conversation
| All the code related to the UI is inside the `site`` folder and we defined a few conventions to help people to navigate through it. | ||
|
|
||
| - **e2e** - E2E tests | ||
| - **src** - Source code |
There was a problem hiding this comment.
We could turn these into links src (not sure about the syntax though). I think that'll let markdown link check catch if any of these links every break due to restructuring, and it's a convenient way to hop in.
There was a problem hiding this comment.
Good one! Annotated to improve this in a next PR.
docs/contributing/frontend.md
Outdated
|
|
||
| ### Where to fetch data | ||
|
|
||
| Finding the right place to fetch data in React apps is the one million dollar question but we decided to make it only in the page components and pass the props down to the views. This makes it easier to find where data is being loaded and easy to test using Storybook - We are going to talk more about our testing strategy. So you will see components like `UsersPage` and `UsersPageView`. |
There was a problem hiding this comment.
[...] We are going to talk more about our testing strategy. So you will see components like
UsersPageandUsersPageView.
This was a bit confusing for me, talk more about it where? And where will I see the components?
| @@ -0,0 +1,133 @@ | |||
| # Frontend | |||
|
|
|||
| This is a guide to help the Coder community and also Coder members contribute to our UI. It is ongoing work but we hope it provides some useful information to get started. If you have any questions or need help, please send us a message on our [Discord server](https://discord.com/invite/coder). We'll be happy to help you. | |||
There was a problem hiding this comment.
Is there any place where we can find a cheatsheet with commands? vite, yarn, how to start Coder in development mode, etc.
There was a problem hiding this comment.
Nops, but it is a good idea! I'm going to send this in a next PR.
Co-authored-by: Kira Pilot <kira@coder.com> Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
No description provided.