Kelvin, when is the boring docs coming? #76
Replies: 7 comments 15 replies
-
|
One thing to keep in mind is covering essential features like Link, Head and useForm (amongst others) that are covered in the inertia docs. Another thing is covering CRUD operations. |
Beta Was this translation helpful? Give feedback.
-
|
So for guides instead of Links and Head, I'll use terms like navigation in the Guide section. Does that make sense @lennyAiko |
Beta Was this translation helpful? Give feedback.
-
|
Yes |
Beta Was this translation helpful? Give feedback.
-
|
Yes there will also be a guide for routing which will link to the Sails docs for more extensive deep dive. Basically The Boring JavaScript Stack docs will provide enough details for you to quickly glance and get on your way building your app but if you want to go deeper, then you can click through to the extensive docs in the technology you are interested in. |
Beta Was this translation helpful? Give feedback.
-
|
That's good enough for me! |
Beta Was this translation helpful? Give feedback.
-
|
One thing I’ll also like to know is how you plan on covering features on sails? |
Beta Was this translation helpful? Give feedback.
-
|
Yeah should be fun to figure all these out. |
Beta Was this translation helpful? Give feedback.
-
|
Okay I have started cooking... https://x.com/Dominus_Kelvin/status/1752039403419992097?s=20 |
Beta Was this translation helpful? Give feedback.
-
|
Also we are tracking this with #77 and also there is a draft PR on the Sailscasts Docs sailscastshq/docs.sailscasts.com#22 |
Beta Was this translation helpful? Give feedback.
-
|
Another thing to probably add to the docs is configuring types. I have been getting a lot of type errors on the sails part of TBJS. The syntax is correct but the type errors just wont give up. so I have to manually disable checking on each file I notice the error. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah I figured it was just a warning. But I just like my screen looking clean. I will check out the |
Beta Was this translation helpful? Give feedback.
-
Yeah what you can do to turn it off is in jsconfig.json change checkJS: false and it should be clean |
Beta Was this translation helpful? Give feedback.
-
|
Just the way I want! Thanks |
Beta Was this translation helpful? Give feedback.
-
|
Yeah I should probably document that. Where would you add that in the docs? Just to turn off types if you don't want it in JS files. @lennyAiko |
Beta Was this translation helpful? Give feedback.
-
|
It can be under configuration, maybe tag it as optional |
Beta Was this translation helpful? Give feedback.
-
|
The documentation should also cover how to redirect for PUT, PATCH, or DELETE requests |
Beta Was this translation helpful? Give feedback.
-
|
A basic version of the docs is now live @lennyAiko |
Beta Was this translation helpful? Give feedback.
-
|
Amazing stuff, you superbly carried out a daunting task! |
Beta Was this translation helpful? Give feedback.
-
I tried! |
Beta Was this translation helpful? Give feedback.
-
Hey all, let me know what pains you've currently seen when using The Boring JavaScript Stack, I plan on having a version of the docs available by the end of this week so let me know what you want to see covered.
Beta Was this translation helpful? Give feedback.
All reactions