docs icon indicating copy to clipboard operation
docs copied to clipboard

feature request: implement diataxis

Open jcstein opened this issue 1 year ago • 11 comments

https://diataxis.fr/

jcstein avatar Apr 19 '24 00:04 jcstein

@jcstein is this open to work on too? also, concerning the organization, do you have anything in mind?

Mackenzie-OO7 avatar Sep 13 '24 20:09 Mackenzie-OO7

assigning myself to work on this one! thank you 😄

jcstein avatar Sep 16 '24 09:09 jcstein

unless you go for it first, but it will be a biiiiiig overhaul

jcstein avatar Sep 16 '24 09:09 jcstein

assigning myself to work on this one! thank you 😄

cool. but i’d still like to assist you, if you don’t mind👀

Mackenzie-OO7 avatar Sep 16 '24 09:09 Mackenzie-OO7

sounds good!

here's what I'm thinking for categories:

  • Learn (as it exists)
  • How to (how to run a node, run op stack, etc.)
  • Tutorials (node API tutorials mainly, etc.)
  • Reference (all existing references, broken down by software)

how do you think that aligns with diataxis and what suggestions do you have based on the model on diataxis?

image

jcstein avatar Sep 16 '24 10:09 jcstein

looks good to me. i think it may be helpful to add a sub-section in the learn category that contains the existing overviews of the different modular stack integrations (op, arbitrum, sovereign, others) then include a link to their respective how-to guides.

what do you think?

Mackenzie-OO7 avatar Sep 16 '24 14:09 Mackenzie-OO7

trying to keep things as minimal as possible so i think integrations belong in how-to-run-X

jcstein avatar Sep 16 '24 16:09 jcstein

I'll arrange this in a Miro mind map and share

Mackenzie-OO7 avatar Sep 18 '24 09:09 Mackenzie-OO7

I'll arrange this in a Miro mind map and share

Mind Maps (2)

Mackenzie-OO7 avatar Sep 18 '24 13:09 Mackenzie-OO7

this looks like a great start to me! thank you for putting this together

jcstein avatar Sep 19 '24 19:09 jcstein

this looks like a great start to me! thank you for putting this together

ty! can I make a draft pr implementing this organization?

Mackenzie-OO7 avatar Sep 25 '24 15:09 Mackenzie-OO7

sure thing! I would be glad to review that.

jcstein avatar Sep 26 '24 22:09 jcstein