Remix.run Logo
jamilbk 6 hours ago

We just invested a good amount of time restructuring our docs for Diátaxis. It was helpful, but I wouldn't take it as gospel. The important thing to remember is that each piece of content should be one of the four types.

If you're embarking upon a refactoring / rewriting journey for your docs, the only advice I'd share is to actually read the website beginning to end before starting. Especially this page: https://diataxis.fr/complex-hierarchies/. The guide is (unsurprisingly) very well written, and it's easy to internalize the concepts because they're repeated often.

DanieleProcida 6 hours ago | parent [-]

Ugh, I don't like that page and I have actually deleted it. It'll be gone soon.

There is a real problem there, and that page doesn't do a good enough job of dealing with it. I have something cooking that is much, much better.

nlawalker 5 hours ago | parent | next [-]

Please post some kind of visible change notification (and something here) when you do!

LoganDark 5 hours ago | parent | prev [-]

It makes sense to me (I agree with it), but I also agree that it doesn't really deal with it. I look forward to whatever you're cooking!