testdeck icon indicating copy to clipboard operation
testdeck copied to clipboard

[DOCUMENTATION] Website Facelift

Open panayot-cankov opened this issue 3 years ago • 7 comments

I want to do some changes on the website that include:

  1. Move the docs into the main repo
    From https://github.com/testdeck/testdeck-site and https://github.com/testdeck/testdeck-jekyll-theme into the docs/ in https://github.com/testdeck/testdeck
    Hopefully this will allow features and docs to be updated simultaneously from a single PR.
  2. Make light/dark homepage themes
    Currently we roll with a light theme, but a lot of developers fancy dark. Adding some "@media preffered dark" CSS to dual style the homepage...
  3. Add some more code and a bit less text blocks on the homepage
    Currently when the homepage is opened the code block is out of sight:
@suite class TestSuite {
  @test
  someTest() {}
}
  1. Make the site a bit more mobile friendly
    Currently on a mobile phone, there are two hamburger buttons (top right, and a little lower to the left), and there is padding that shrinks the content to 4 to 5 words per line.

WIP There is some content in the docs/ currently that will be replaced with the WIP from here: https://github.com/testdeck/docs

A preview is available here: https://testdeck.github.io/docs/

All the content from the existing site should be preserved except for the landing page.

panayot-cankov avatar Sep 16 '22 07:09 panayot-cankov

@panayot-cankov since we are now using cookies to keep track of the selected test framework, we might want to inform users of the site that cookies are being used, in order to comply to current legislation?

Or can we not just get rid of the cookie and use a global variable instead?

And when we have multiple pages, we could pass the currently selected test framework as a parameter instead of keeping it as a cookie.

That way we would be clear from the requirements set forth by the GDPR and will not harass our users with forcing them to repeatedly accept these necessary cookies.

silkentrance avatar Sep 24 '22 18:09 silkentrance

How about making the logo/test framework selection section persistent in that it will not scroll but rather stick to the top and then let users still switch between different test frameworks while walking through the existing code examples?

I see that this is currently working for portrait mobile resolutions, however, the actual content can be switched off/on by the "thing" on the left while test framework selection is still available. It does not work for desktops, though.

What about using JQuery? In addition we could also use a CSS framework, e.g. Tailwind CSS.

And we could also add in some diagrams using Mermaid JS 👍, e.g. for depicting test suite inheritance and so on.

silkentrance avatar Sep 24 '22 18:09 silkentrance

@panayot-cankov can you make this a PR based on current main?

silkentrance avatar Sep 24 '22 19:09 silkentrance

Using tailwind with jekyll: https://stevenwestmoreland.com/2021/01/using-tailwind-css-with-jekyll.html

silkentrance avatar Sep 24 '22 19:09 silkentrance

Do you need any help to get the site deployed again? :)

adaliszk avatar Jun 07 '24 06:06 adaliszk

@panayot-cankov did you disconnect the testdeck.org domain? I have changed the link in the project to https://testdeck.github.io/docs/

is this because of https://www.aviator.co/testdeck a/o #386 a/o https://github.com/mercari/testdeck a/o ...?

https://www.aviator.co/blog/announcing-testdeck/

did they come up to you?

silkentrance avatar Jun 08 '24 15:06 silkentrance