-
-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add overview page to documentation #200
Add overview page to documentation #200
Conversation
The overview page provided users with a map to navigate the documentation while it keeps growing. As systematic approach the Diataxis framework is introduced.
ad2a971
to
a5696f0
Compare
Just FYI: I created the overview page by looking at the Django documentation, which also uses Diataxis. Always good to have a reference. |
src/docs/overview.md
Outdated
@@ -0,0 +1,36 @@ | |||
# Overview | |||
|
|||
Everything you need to know about Emmet and Event Sourcing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
COMMENT: Later on in Overview, we should probably do more information like I did once in Marten (so what it is and main features) https://martendb.io/introduction.html#what-is-marten.
But this can go as a follow-up.
src/docs/overview.md
Outdated
|
||
## How the documenantation is organized | ||
|
||
Currently documentation for Emmet is spread across several places: This website, the Emmet Discord and quite a few blog articles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
COMMENT: Maybe we could link those articles here? Thoughts. And tell something along the lines:
You can also find more information about Emmett in those articles. We're working on including all the knowledge centralised in this website.
Then, what you did below.
@tburny, thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather keep the overview page concise. My idea would be to have "Further reading sections" at the bottom of the documentation pages that link to the respective blog articles relevant in that context.
As a first step we can have such a section in the overview and migrate them from there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just added the link in a "Further reading" section so they are at least somewhere in the documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense to me, thanks for doing it 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tburny thank you for doing that, I added small comments and suggestions. After they're resolved, I'm more than happy to pull that in.
I implemented the changes as requested (i.e. spelling Emmett correctly). Also I added some minor improvements:
Ready for the second round! |
@tburny I think that for now, it makes sense to route people directly to getting started, later on, we can enhance it when we have more content 🙂 Thanks again for sending those docs updates; they are much appreciated! |
The overview page provided users with a map to navigate the documentation while it keeps growing with the project.
While currently there are only two pages (Getting Started and API docs), this is going to change in the near future with further refactorings and improvements to the documentation.
This PR also introduces Diataxis - without imposing a folder structure at the moment to allow for organic growth.