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

Add overview page to documentation #200

Merged

Conversation

tburny
Copy link
Contributor

@tburny tburny commented Feb 24, 2025

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.

The overview page provided users with a map to navigate the documentation while it keeps growing.

As systematic approach the Diataxis framework is introduced.
@tburny tburny force-pushed the feature/add-overview-page-to-docs branch from ad2a971 to a5696f0 Compare February 24, 2025 22:10
@tburny
Copy link
Contributor Author

tburny commented Feb 25, 2025

Just FYI: I created the overview page by looking at the Django documentation, which also uses Diataxis. Always good to have a reference.

@@ -0,0 +1,36 @@
# Overview

Everything you need to know about Emmet and Event Sourcing.
Copy link
Collaborator

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.


## 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.
Copy link
Collaborator

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

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 👍

Copy link
Collaborator

@oskardudycz oskardudycz left a 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.

@oskardudycz oskardudycz added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 26, 2025
@oskardudycz oskardudycz modified the milestones: 0.30.0, 0.31.0, 0.32.0 Feb 26, 2025
@tburny
Copy link
Contributor Author

tburny commented Feb 27, 2025

I implemented the changes as requested (i.e. spelling Emmett correctly). Also I added some minor improvements:

  • adding the blog links as "further reading" section and linking to the section from within the "Overview" page
  • add links to Discord in the overview page
  • There was no way from the landing page to the overview page, so I simply added it to the main nav and made "getting stated" a menu item there. This way new users will probably click the "getting stated" link (call to action), while if I am looking for something else I can still use the menu to roughly navigate to my area of interest (e.g. API reference).

Ready for the second round!

@oskardudycz
Copy link
Collaborator

@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!

@oskardudycz oskardudycz merged commit 1b09e44 into event-driven-io:main Feb 28, 2025
1 check passed
@tburny tburny deleted the feature/add-overview-page-to-docs branch February 28, 2025 23:30
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 this pull request may close these issues.

2 participants