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

Docs restructure #334

Merged
merged 18 commits into from
Jul 19, 2022
Merged

Docs restructure #334

merged 18 commits into from
Jul 19, 2022

Conversation

SmileyChris
Copy link
Contributor

The documentation has grown larger than the categorisation being used. I've moved the documents into a format that resembles the https://diataxis.fr/ framework ideals.

I've also rewritten the tutorial to a several step process, and created the start of some reference documentation.

There's still more work that could be done on it (obviously - docs are never really "done"), but I haven't removed anything that's in the current docs. Take a look, anyway!

@SmileyChris
Copy link
Contributor Author

@vitalik I rebased against latest master, fixing conflicts and ensuring everything lives under the new layout (my recently merged temporal response docs aren't even in the current live docs index page, oops)

@SmileyChris
Copy link
Contributor Author

Hey @vitalik -- I keep this branch updated, but if it's too big of a change or you don't like the direction I went in then just let me know so I can close the branch rather than updating it in futility ;)

@vitalik vitalik merged commit a3d6636 into vitalik:master Jul 19, 2022
@vitalik
Copy link
Owner

vitalik commented Jul 19, 2022

Hi @SmileyChris

Yes, I like the structure
but most likely will improve the tutorial section

Thank you

@SmileyChris
Copy link
Contributor Author

🥳 Yay for the merge!

I agree that the tutorial section can use some more love. Now with the better structure, it's easier to start thinking about the documentation in each section with a bit more purpose.

As the diataxis framework explains it:

documentiation sections

@SmileyChris SmileyChris deleted the docs-restructure branch July 19, 2022 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants