Kelvin, when is the boring docs coming?

[DominusKelvin]

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.

[lennyAiko]

One thing to keep in mind is covering essential features like Link, Head and useForm (amongst others) that are covered in the inertia docs.
Just leaving it here so you can be remember.

Another thing is covering CRUD operations.

[DominusKelvin]

So for guides instead of Links and Head, I'll use terms like navigation in the Guide section. Does that make sense @lennyAiko

[lennyAiko]

Yes Navigation makes sense, it is clear enough to be differentiated from Routing

[DominusKelvin]

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.

[lennyAiko]

That's good enough for me!

[lennyAiko]

One thing I’ll also like to know is how you plan on covering features on sails?
Since a lot of it are already on the docs

[DominusKelvin]

Yeah should be fun to figure all these out.

[DominusKelvin]

Okay I have started cooking...

https://x.com/Dominus_Kelvin/status/1752039403419992097?s=20

[DominusKelvin]

Also we are tracking this with #77 and also there is a draft PR on the Sailscasts Docs sailscastshq/docs.sailscasts.com#22

[lennyAiko]

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.

[lennyAiko]

Yeah I figured it was just a warning. But I just like my screen looking clean. I will check out the types/index.d.ts. Thanks

[DominusKelvin]

Yeah I figured it was just a warning. But I just like my screen looking clean. I will check out the types/index.d.ts. Thanks

Yeah what you can do to turn it off is in jsconfig.json change checkJS: false and it should be clean ☺️

[lennyAiko]

Just the way I want! Thanks

[DominusKelvin]

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

[lennyAiko]

It can be under configuration, maybe tag it as optional

[lennyAiko]

The documentation should also cover how to redirect for PUT, PATCH, or DELETE requests

[DominusKelvin]

A basic version of the docs is now live @lennyAiko
https://docs.sailscasts.com/boring-stack/getting-started

[lennyAiko]

Amazing stuff, you superbly carried out a daunting task!

[DominusKelvin]

Amazing stuff, you superbly carried out a daunting task!

I tried!