-
Notifications
You must be signed in to change notification settings - Fork 568
Description
Hello everyone ^_^ /
I've been messing around with rlm for a while,
and even though I've been having fun wasting tokens
I wished the documentations were easier to add to
so I had the novel idea to just make every page a markdown.
Why? - next.js documentation for this scale and growth is a productivity bottleneck
Anyone trying to add to the documentation must go through satan's alchemy (writing react)
which pushes the incentive to write ANY documentation to dead zero
Solution? - a markdown based documentation platform (.mdx to be fancier)
I chose mintlify as it was the fastest and most "just works" platform I know personally
If you guys know of any other I will be hearing you out.
I spent a little time and built and hosted a small replica of the current docs to see what you guys think
How is it? - right now it's very unclean and most things are paraphrased
It bothered me and I wanted to spend the rest of my day correcting all of it.
But I thought I need public's and dev's thoughts before spending a lot of time making it prod ready
Where? Right here :>
Experimental Mintlify Docs:
Hosted experimental docs
Repo:
How it's structured
"I hate the design"
There were like 6 or 7 different themes and I chose one randomly off vibes
We can absolutely make it nicer
"Where are the tables and pictures"
Please imagine them
Main takeaway? - less react more markdown
documenting wont feel like a chore
markdown docs are always faster, lighter and more reliable
people like them more, agents love them
there are cases where nextjs would make sense
such as deeply interactive sandboxes or if you have a dedicated docs team
but for now markdown seems to be the clear winner
Thank you for reading this! waiting to know what you lovely people think
it's currently 5:57am have a great night.