search

nautilus-cyberneering / secure-git-guide

A collections of articles about Git, GitHub and GPG focused on security.
https://secure-git.guide
8 stars 5 forks source link

No ability to move from article to article #67

Open grmbyrn opened 11 months ago

grmbyrn commented 11 months ago

Instead of being able to move from article to article once one has been read, the user must always first return to home through the Back to home button before starting the next article. This isn't intuitive for most internet users who are used to being able to progress through previous and next articles on many websites, as easily as you would with a book or newspaper. This would be especially useful here as each article seems to lead from the previous one. This could be done by adding a link in the .md file for each article with links to the Previous and Next articles.

Also, the emojis next to the heading for Articles are misleading. A lock emoji/image on the internet is widely known to indicate that access is limited to certain users, such as articles which are behind a paywall. While the lock and key emoji combination may be to suggest that these articles will unlock some knowledge, it is a much less common combination to see online and the first impression is that these articles are only for use by some. If the emojis are to express the knowledge contained in these articles, perhaps 🤓 or 🧠 would express it better.

josecelano commented 11 months ago

Hi @grmbyrn Yes, the UI is not the best :-). We wanted something easy to change (markdown) and with code highlighting because most articles contain sample code. We are using the Cinder Theme for MkDocs and probably not getting the most from it.

We also got a proposal from a designer.

secure_git_guide

grmbyrn commented 11 months ago

Hi @josecelano, that already looks so much better with a clearer structure, colours, and images. If the designer supplied a Figma or something similar then I would love to have a go at creating something like this, if that would be interesting.

Also, I see that HTML has the < pre> and < code> elements, as well as syntax highlighting libraries, which could accommodate the sample code and enable the page to be streamlined into a more manageable project.

josecelano commented 11 months ago

Hi @josecelano, that already looks so much better with a clearer structure, colours, and images. If the designer supplied a Figma or something similar then I would love to have a go at creating something like this, if that would be interesting.

Also, I see that HTML has the < pre> and < code> elements, as well as syntax highlighting libraries, which could accommodate the sample code and enable the page to be streamlined into a more manageable project.

I do not know if we have the Figma. We can ask @da2ce7. I only have that screenshot. If we consider changing the template, maybe we could also migrate to svelte, which is the framework we want to use for this type of static site (for example, the torrust.com site).

grmbyrn commented 11 months ago

I do not know if we have the Figma. We can ask @da2ce7. I only have that screenshot. If we consider changing the template, maybe we could also migrate to svelte, which is the framework we want to use for this type of static site (for example, the torrust.com site).

A Figma file or something similar would be great for sizes, colours, spacing, etc, but it's good to even have the screenshot to work from initially. I have experience with React, but would love the opportunity to explore Svelte for this project, especially if that's what you're planning to move forward with in the future for other projects.