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

Rename Docs to "Learn Matrix" and add it to the Try Matrix page #2555

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MTRNord
Copy link
Collaborator

@MTRNord MTRNord commented Nov 9, 2024

This is a result of a discussion with @HarHarLinks .

The icon illustration is the Gnome UI Icon "document-text" which is CC Zero licensed and was modified to fit the same corner style like the other illustrations. However I would prefer a proper illustration here instead.

grafik

@MTRNord MTRNord added the enhancement This would be an improvement to the website. label Nov 9, 2024
@HarHarLinks
Copy link
Contributor

I was comparing the m.org website's categories to where other projects might have "Learn more" and "Get started" sections. To me, "Docs" sounds too dry and not interesting to actually read, but more technical - when actually we want it to be end user facing docs that go a little beyond "getting started" (i.e. jumping in head first to try it out).

We should also clean the section's contents itself up. I find it does not fit the way the rest of the website is designed and the mix of "Matrix for chat" and "Spec guide for implementing authenticated media in the federation API" don't at all fit together.

@thibaultamartin
Copy link
Contributor

Point taken and I agree that Docs is a bit try. I'm wondering if "Learning Matrix" is really more engaging though.

Could something along the lines of "Get started" or "Use Matrix" make more sense?

@@ -9,6 +9,26 @@ <h1>{{ page.title }}</h1>

<div class="try_matrix">
<div class="step-background">
<div class="step choose-a-client">
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class is probably wrong :D

Copy link
Contributor

@thibaultamartin thibaultamartin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few nits here and there, nothing too significant.

As an aside, the handbook svg doesn't look fantastic but in all fairness all the pictures on the existing page are not exactly great either.

We will have to request some Jordan time to get nicer illustrations, but that's not a blocker for this PR.

@@ -9,6 +9,26 @@ <h1>{{ page.title }}</h1>

<div class="try_matrix">
<div class="step-background">
<div class="step choose-a-client">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<div class="step choose-a-client">
<div class="step">

Matrix</a>
</div>
</div>
<img src="/assets/try-matrix/handbook.svg" alt="Artist view of an abstract matrix client." />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alt text probably needs an update :)

@@ -23,7 +43,7 @@ <h3>Choose a client</h3>
<img src="/assets/try-matrix/client.svg" alt="Artist view of an abstract matrix client." />
</div>
</div>
<div class="step-background coloured">
<div class="step-background">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker for the PR, but it'd be nice to use :nth-child() instead of manually adding/removing the class

https://developer.mozilla.org/en-US/docs/Web/CSS/:nth-child#keyword_values

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This would be an improvement to the website.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants