Have an isolate document site

[blackmouse572]

I really like the way this repository documented, clear and easy to understand. Hower, readme is not enough for me, the syntax is bad, hard to read.
I think it is better if we have a dedicated document site like mintify, fumadocs so that developers can read it easier, it also help to track and navigation transparent.

I would like to contribute if you interested

[blackmouse572]

I just saw this when looking for light nestjs boilerplate and found someone already do this https://narhakobyan.github.io/awesome-nest-boilerplate/docs/development.html#docker-installation

[andrechristikan]

hi @blackmouse572
great suggestion! a dedicated documentation site would definitely improve the developer experience

just quick question first. are you okay with using free open-source tools?
like Fumadocs, VitePress, Docusaurus or anything else. those are completely free, while Mintlify requires paid plans

also, we won't need a new repo - we can set up everything in this repository with a /docs folder and use GitHub Pages for hosting

if you're interested, let me know which tool you prefer
thanks

[blackmouse572]

just quick question first. are you okay with using free open-source tools?

Yeah, I won't mind

like Fumadocs, VitePress, Docusaurus or anything else. those are completely free, while Mintlify requires paid plans

While Vitepress and Docusaurus can easily deploy with GitHub Pages, Fumadocs is not, since it built on top of nextjs
There said, if go to Fumadocs, you will need a separate repo for it, it not ideal to inject a whole framework to this boilerplate

if you're interested, let me know which tool you prefer

Fumadocs is interesting, I want to try it our, it getting hype recently, and many features like table types, code syntax with type on hovering will be cool as f*ck. and open-api built in too 👍🏻

[blackmouse572]

My company is Vitepress, the experience is good. But fumadocs still look better :D