Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: implement diataxis #1534

Closed
jcstein opened this issue Apr 19, 2024 · 12 comments · Fixed by #1742
Closed

feature request: implement diataxis #1534

jcstein opened this issue Apr 19, 2024 · 12 comments · Fixed by #1742
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jcstein
Copy link
Member

jcstein commented Apr 19, 2024

https://diataxis.fr/

@jcstein jcstein added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 22, 2024
@Mackenzie-OO7
Copy link
Contributor

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

@jcstein jcstein self-assigned this Sep 16, 2024
@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

assigning myself to work on this one! thank you 😄

@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

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

@Mackenzie-OO7
Copy link
Contributor

assigning myself to work on this one! thank you 😄

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

@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

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

@Mackenzie-OO7
Copy link
Contributor

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?

@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

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

@Mackenzie-OO7
Copy link
Contributor

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

@Mackenzie-OO7
Copy link
Contributor

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

Mind Maps (2)

@jcstein
Copy link
Member Author

jcstein commented Sep 19, 2024

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

@Mackenzie-OO7
Copy link
Contributor

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

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

@jcstein
Copy link
Member Author

jcstein commented Sep 26, 2024

sure thing! I would be glad to review that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants